/ Каталог / Песочница / obsidian-plugin-skill
● Сообщество gapmiss ⚡ Сразу

obsidian-plugin-skill

автор gapmiss · gapmiss/obsidian-plugin-skill

An Agent Skill that teaches Claude how to build Obsidian plugins — Plugin API, manifest.json, release flow.

obsidian-plugin-skill loads the Obsidian Plugin API shape into Claude's working memory: manifest.json + versions.json, main.ts plugin skeleton, settings tabs, commands, ribbon icons, editor extensions, and the release-via-GitHub-tag flow the official Community store expects. Useful when you want to prototype a plugin in an afternoon.

Зачем использовать

Ключевые функции

Живое демо

Как выглядит на практике

obsidian-plugin-skill.replay ▶ готово
0/0

Установка

Выберите клиент

~/Library/Application Support/Claude/claude_desktop_config.json  · Windows: %APPDATA%\Claude\claude_desktop_config.json
{
  "mcpServers": {
    "obsidian-plugin-skill": {
      "command": "git",
      "args": [
        "clone",
        "https://github.com/gapmiss/obsidian-plugin-skill",
        "~/.claude/skills/obsidian-plugin-skill"
      ],
      "_inferred": true
    }
  }
}

Откройте Claude Desktop → Settings → Developer → Edit Config. Перезапустите после сохранения.

~/.cursor/mcp.json · .cursor/mcp.json
{
  "mcpServers": {
    "obsidian-plugin-skill": {
      "command": "git",
      "args": [
        "clone",
        "https://github.com/gapmiss/obsidian-plugin-skill",
        "~/.claude/skills/obsidian-plugin-skill"
      ],
      "_inferred": true
    }
  }
}

Cursor использует ту же схему mcpServers, что и Claude Desktop. Конфиг проекта приоритетнее глобального.

VS Code → Cline → MCP Servers → Edit
{
  "mcpServers": {
    "obsidian-plugin-skill": {
      "command": "git",
      "args": [
        "clone",
        "https://github.com/gapmiss/obsidian-plugin-skill",
        "~/.claude/skills/obsidian-plugin-skill"
      ],
      "_inferred": true
    }
  }
}

Щёлкните значок MCP Servers на боковой панели Cline, затем "Edit Configuration".

~/.codeium/windsurf/mcp_config.json
{
  "mcpServers": {
    "obsidian-plugin-skill": {
      "command": "git",
      "args": [
        "clone",
        "https://github.com/gapmiss/obsidian-plugin-skill",
        "~/.claude/skills/obsidian-plugin-skill"
      ],
      "_inferred": true
    }
  }
}

Тот же формат, что и Claude Desktop. Перезапустите Windsurf для применения.

~/.continue/config.json
{
  "mcpServers": [
    {
      "name": "obsidian-plugin-skill",
      "command": "git",
      "args": [
        "clone",
        "https://github.com/gapmiss/obsidian-plugin-skill",
        "~/.claude/skills/obsidian-plugin-skill"
      ]
    }
  ]
}

Continue использует массив объектов серверов, а не map.

~/.config/zed/settings.json
{
  "context_servers": {
    "obsidian-plugin-skill": {
      "command": {
        "path": "git",
        "args": [
          "clone",
          "https://github.com/gapmiss/obsidian-plugin-skill",
          "~/.claude/skills/obsidian-plugin-skill"
        ]
      }
    }
  }
}

Добавьте в context_servers. Zed перезагружается автоматически.

claude mcp add obsidian-plugin-skill -- git clone https://github.com/gapmiss/obsidian-plugin-skill ~/.claude/skills/obsidian-plugin-skill

Однострочная команда. Проверить: claude mcp list. Удалить: claude mcp remove.

Сценарии использования

Реальные сценарии: obsidian-plugin-skill

How to build and release your first Obsidian plugin

👤 Obsidian power users who want to scratch an itch ⏱ ~120 min intermediate

Когда использовать: You have a concrete workflow improvement and want a plugin in a day.

Предварительные требования
  • Node 18+ — nvm install 18
  • A local vault for testing — Create a new Obsidian vault just for development
  • Skill cloned — git clone https://github.com/gapmiss/obsidian-plugin-skill ~/.claude/skills/obsidian-plugin-skill
Поток
  1. Scaffold the plugin
    Scaffold an Obsidian plugin called 'smart-outline' with a command and a settings tab.✓ Скопировано
    → Folder with manifest, main.ts, build config
  2. Add the feature
    Implement: on command, open a modal showing the outline of the active note.✓ Скопировано
    → Working modal reading from the active MarkdownView
  3. Side-load and test
    Install into the dev vault's plugins folder and reload Obsidian.✓ Скопировано
    → Plugin shows up, command works
  4. Prepare a release
    Create versions.json and tag a v0.1.0 release.✓ Скопировано
    → GitHub release with main.js + manifest.json attached

Итог: A working, installable plugin you can submit to the Community store.

Подводные камни
  • Forgetting versions.json — Community store rejects — Skill reminds; always keep it in sync with manifest.json
  • Referencing Obsidian internals that aren't part of the API — Stick to the public API; treat internals as volatile
Сочетать с: filesystem · github

Add a proper settings tab to an existing plugin

👤 Existing plugin authors improving UX ⏱ ~30 min intermediate

Когда использовать: Your plugin has grown and needs user-configurable options.

Поток
  1. Design the settings
    Based on my plugin's README, what settings should be user-configurable?✓ Скопировано
    → Short list with rationale
  2. Implement PluginSettingTab
    Add a PluginSettingTab with those controls.✓ Скопировано
    → Settings UI in Obsidian

Итог: A settings tab users can actually use.

Подводные камни
  • Too many settings — Ruthlessly cut — unused settings are clutter

Комбинации

Сочетайте с другими MCP — эффект x10

obsidian-plugin-skill + filesystem

Read an existing plugin and extend it

Read my-plugin/, add a new command that exports the active note as PDF.✓ Скопировано
obsidian-plugin-skill + github

Automate tagging and release creation

Tag v0.2.0 and publish release with the built assets.✓ Скопировано

Инструменты

Что предоставляет этот MCP

ИнструментВходные данныеКогда вызыватьСтоимость
plugin-scaffolding plugin intent New plugin 0
feature-authoring feature spec + API surface Every feature 0
settings-tab options UX improvements 0
release-flow version bump Before publishing 0

Стоимость и лимиты

Во что обходится

Квота API
none
Токенов на вызов
5–20k per plugin
Деньги
free
Совет
Work feature-by-feature rather than dumping a full plugin spec on Claude

Безопасность

Права, секреты, радиус поражения

Хранение учётных данных: GitHub token for releases (if automating)
Исходящий трафик: none at skill layer

Устранение неполадок

Частые ошибки и исправления

Obsidian doesn't load the plugin

Confirm manifest.json is valid JSON and in the right vault path; reload via Ctrl+R.

Проверить: cat .obsidian/plugins/my-plugin/manifest.json | jq .
Build produces no main.js

Run the esbuild command; check tsconfig target.

Проверить: ls main.js

Альтернативы

obsidian-plugin-skill в сравнении

АльтернативаКогда использоватьКомпромисс
logseqYou're on Logseq rather than ObsidianDifferent plugin API

Ещё

Ресурсы

📖 Читать официальный README на GitHub

🐙 Открытые задачи

🔍 Все 400+ MCP-серверов и Skills