/ Verzeichnis / Playground / obsidian-plugin-skill
● Community gapmiss ⚡ Sofort

obsidian-plugin-skill

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

Warum nutzen

Hauptfunktionen

Live-Demo

In der Praxis

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

Installieren

Wählen Sie Ihren Client

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

Öffne Claude Desktop → Settings → Developer → Edit Config. Nach dem Speichern neu starten.

~/.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 nutzt das gleiche mcpServers-Schema wie Claude Desktop. Projektkonfiguration schlägt die globale.

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

Klicken Sie auf das MCP-Servers-Symbol in der Cline-Seitenleiste, dann "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
    }
  }
}

Gleiche Struktur wie Claude Desktop. Windsurf neu starten zum Übernehmen.

~/.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 nutzt ein Array von Serverobjekten statt einer 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"
        ]
      }
    }
  }
}

In context_servers hinzufügen. Zed lädt beim Speichern neu.

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

Einzeiler. Prüfen mit claude mcp list. Entfernen mit claude mcp remove.

Anwendungsfälle

Praxisnahe Nutzung: obsidian-plugin-skill

How to build and release your first Obsidian plugin

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

Wann einsetzen: You have a concrete workflow improvement and want a plugin in a day.

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

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

Fallstricke
  • 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
Kombinieren mit: filesystem · github

Add a proper settings tab to an existing plugin

👤 Existing plugin authors improving UX ⏱ ~30 min intermediate

Wann einsetzen: Your plugin has grown and needs user-configurable options.

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

Ergebnis: A settings tab users can actually use.

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

Kombinationen

Mit anderen MCPs für 10-fache Wirkung

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

Automate tagging and release creation

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

Werkzeuge

Was dieses MCP bereitstellt

WerkzeugEingabenWann aufrufenKosten
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

Kosten & Limits

Was der Betrieb kostet

API-Kontingent
none
Tokens pro Aufruf
5–20k per plugin
Kosten in €
free
Tipp
Work feature-by-feature rather than dumping a full plugin spec on Claude

Sicherheit

Rechte, Secrets, Reichweite

Credential-Speicherung: GitHub token for releases (if automating)
Datenabfluss: none at skill layer

Fehlerbehebung

Häufige Fehler und Lösungen

Obsidian doesn't load the plugin

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

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

Run the esbuild command; check tsconfig target.

Prüfen: ls main.js

Alternativen

obsidian-plugin-skill vs. andere

AlternativeWann stattdessenKompromiss
logseqYou're on Logseq rather than ObsidianDifferent plugin API

Mehr

Ressourcen

📖 Offizielle README auf GitHub lesen

🐙 Offene Issues ansehen

🔍 Alle 400+ MCP-Server und Skills durchsuchen