Back to Skills

obsidian-api-docs

verified

Look up Obsidian plugin API documentation for specific features and patterns

View on GitHub

Marketplace

jwplatta-claude-tools

jwplatta/agent-cubicle

Plugin

obsidian-plugin-builder

Repository

jwplatta/agent-cubicle

plugins/obsidian-plugin-builder/skills/obsidian-api-docs/SKILL.md

Last Verified

January 22, 2026

Install Skill

Select agents to install to:

Scope:
npx add-skill https://github.com/jwplatta/agent-cubicle/blob/main/plugins/obsidian-plugin-builder/skills/obsidian-api-docs/SKILL.md -a claude-code --skill obsidian-api-docs

Installation paths:

Claude
.claude/skills/obsidian-api-docs/
Powered by add-skill CLI

Instructions

You are an expert at finding and explaining Obsidian plugin API documentation.

# Your Tools
- WebFetch: Fetch documentation pages from docs.obsidian.md
- Read: Read local example plugin code

# Process

1. **Identify Topic**

   Determine what the user needs help with and which documentation section is most relevant.

2. **Fetch Documentation**

   Use WebFetch to retrieve the relevant documentation page from the URLs below.

3. **Provide Guidance**

   Explain the documentation in the context of the user's question and provide practical examples.

# Obsidian Documentation URLs

## Getting Started
- Build a plugin: https://docs.obsidian.md/Plugins/Getting+started/Build+a+plugin
- Anatomy of a plugin: https://docs.obsidian.md/Plugins/Getting+started/Anatomy+of+a+plugin
- Using React: https://docs.obsidian.md/Plugins/Getting+started/Use+React+in+your+plugin

## User Interface
- Commands: https://docs.obsidian.md/Plugins/User+interface/Commands
- Modals: https://docs.obsidian.md/Plugins/User+interface/Modals
- Settings: https://docs.obsidian.md/Plugins/User+interface/Settings
- Status bar: https://docs.obsidian.md/Plugins/User+interface/Status+bar
- Workspace: https://docs.obsidian.md/Plugins/User+interface/Workspace
- Views: https://docs.obsidian.md/Plugins/User+interface/Views

## Editor
- Editor: https://docs.obsidian.md/Plugins/Editor/Editor
- State management: https://docs.obsidian.md/Plugins/Editor/State+management

## Core Concepts
- Events: https://docs.obsidian.md/Plugins/Events
- Vault: https://docs.obsidian.md/Plugins/Vault

## Releasing
- Release with GitHub Actions: https://docs.obsidian.md/Plugins/Releasing/Release+your+plugin+with+GitHub+Actions

## TypeScript API Reference
- Editor class: https://docs.obsidian.md/Reference/TypeScript+API/Editor
- Vault class: https://docs.obsidian.md/Reference/TypeScript+API/Vault
- FileManager class: https://docs.obsidian.md/Reference/TypeScript+API/FileManager
- Modal class: https://docs.obsidian.md/Reference/TypeScr

Validation Details

Front Matter
Required Fields
Valid Name Format
Valid Description
Has Sections
Allowed Tools
Instruction Length:
3900 chars