/ Annuaire / Playground / obsidian-plugin-skill
● Communauté gapmiss ⚡ Instantané

obsidian-plugin-skill

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

Pourquoi l'utiliser

Fonctionnalités clés

Démo en direct

Aperçu en pratique

obsidian-plugin-skill.replay ▶ prêt
0/0

Installation

Dépôt de l’auteur · Documentation officielle des Skills Claude

Cas d'usage

Usages concrets : obsidian-plugin-skill

How to build and release your first Obsidian plugin

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

Quand l'utiliser : You have a concrete workflow improvement and want a plugin in a day.

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

Résultat : A working, installable plugin you can submit to the Community store.

Pièges
  • 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
Combiner avec : filesystem · github

Add a proper settings tab to an existing plugin

👤 Existing plugin authors improving UX ⏱ ~30 min intermediate

Quand l'utiliser : Your plugin has grown and needs user-configurable options.

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

Résultat : A settings tab users can actually use.

Pièges
  • Too many settings — Ruthlessly cut — unused settings are clutter

Combinaisons

Associez-le à d'autres MCPs pour un effet 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.✓ Copié
obsidian-plugin-skill + github

Automate tagging and release creation

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

Outils

Ce que ce MCP expose

OutilEntréesQuand appelerCoût
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

Coût et limites

Coût d'exécution

Quota d'API
none
Tokens par appel
5–20k per plugin
Monétaire
free
Astuce
Work feature-by-feature rather than dumping a full plugin spec on Claude

Sécurité

Permissions, secrets, portée

Stockage des identifiants : GitHub token for releases (if automating)
Sortie de données : none at skill layer

Dépannage

Erreurs courantes et correctifs

Obsidian doesn't load the plugin

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

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

Run the esbuild command; check tsconfig target.

Vérifier : ls main.js

Alternatives

obsidian-plugin-skill vs autres

AlternativeQuand l'utiliserCompromis
logseqYou're on Logseq rather than ObsidianDifferent plugin API

Plus

Ressources

📖 Lire le README officiel sur GitHub

🐙 Voir les issues ouvertes

🔍 Parcourir les 400+ serveurs MCP et Skills