/ Diretório / Playground / obsidian-plugin-skill
● Comunidade gapmiss ⚡ Instantâneo

obsidian-plugin-skill

por 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.

Por que usar

Principais recursos

Demo ao vivo

Como fica na prática

obsidian-plugin-skill.replay ▶ pronto
0/0

Instalar

Escolha seu cliente

~/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
    }
  }
}

Abra Claude Desktop → Settings → Developer → Edit Config. Reinicie após salvar.

~/.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 usa o mesmo esquema mcpServers que o Claude Desktop. Config de projeto vence a global.

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
    }
  }
}

Clique no ícone MCP Servers na barra lateral do Cline, depois "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
    }
  }
}

Mesmo formato do Claude Desktop. Reinicie o Windsurf para aplicar.

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

O Continue usa um array de objetos de servidor em vez de um 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"
        ]
      }
    }
  }
}

Adicione em context_servers. Zed recarrega automaticamente ao salvar.

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

Uma linha só. Verifique com claude mcp list. Remova com claude mcp remove.

Casos de uso

Usos do mundo real: obsidian-plugin-skill

How to build and release your first Obsidian plugin

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

Quando usar: You have a concrete workflow improvement and want a plugin in a day.

Pré-requisitos
  • 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
Fluxo
  1. Scaffold the plugin
    Scaffold an Obsidian plugin called 'smart-outline' with a command and a settings tab.✓ Copiado
    → Folder with manifest, main.ts, build config
  2. Add the feature
    Implement: on command, open a modal showing the outline of the active note.✓ Copiado
    → Working modal reading from the active MarkdownView
  3. Side-load and test
    Install into the dev vault's plugins folder and reload Obsidian.✓ Copiado
    → Plugin shows up, command works
  4. Prepare a release
    Create versions.json and tag a v0.1.0 release.✓ Copiado
    → GitHub release with main.js + manifest.json attached

Resultado: A working, installable plugin you can submit to the Community store.

Armadilhas
  • 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
Combine com: filesystem · github

Add a proper settings tab to an existing plugin

👤 Existing plugin authors improving UX ⏱ ~30 min intermediate

Quando usar: Your plugin has grown and needs user-configurable options.

Fluxo
  1. Design the settings
    Based on my plugin's README, what settings should be user-configurable?✓ Copiado
    → Short list with rationale
  2. Implement PluginSettingTab
    Add a PluginSettingTab with those controls.✓ Copiado
    → Settings UI in Obsidian

Resultado: A settings tab users can actually use.

Armadilhas
  • Too many settings — Ruthlessly cut — unused settings are clutter

Combinações

Combine com outros MCPs para 10× de alavancagem

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.✓ Copiado
obsidian-plugin-skill + github

Automate tagging and release creation

Tag v0.2.0 and publish release with the built assets.✓ Copiado

Ferramentas

O que este MCP expõe

FerramentaEntradasQuando chamarCusto
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

Custo e limites

O que custa rodar

Cota de API
none
Tokens por chamada
5–20k per plugin
Monetário
free
Dica
Work feature-by-feature rather than dumping a full plugin spec on Claude

Segurança

Permissões, segredos, alcance

Armazenamento de credenciais: GitHub token for releases (if automating)
Saída de dados: none at skill layer

Solução de problemas

Erros comuns e correções

Obsidian doesn't load the plugin

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

Verificar: cat .obsidian/plugins/my-plugin/manifest.json | jq .
Build produces no main.js

Run the esbuild command; check tsconfig target.

Verificar: ls main.js

Alternativas

obsidian-plugin-skill vs. outros

AlternativaQuando usarTroca
logseqYou're on Logseq rather than ObsidianDifferent plugin API

Mais

Recursos

📖 Leia o README oficial no GitHub

🐙 Ver issues abertas

🔍 Ver todos os 400+ servidores MCP e Skills