Bill
08cc6e9ea6
🎉 Initial release of Obsidian MCP Server plugin
Core Features:
- MCP server implementation with HTTP transport
- JSON-RPC 2.0 message handling
- Protocol version 2024-11-05 support
MCP Tools:
- read_note, create_note, update_note, delete_note
- search_notes, list_notes, get_vault_info
Server Features:
- Configurable HTTP server (default port: 3000)
- Health check and MCP endpoints
- Auto-start option
Security:
- Origin header validation (DNS rebinding protection)
- Optional Bearer token authentication
- CORS configuration
UI:
- Settings panel with full configuration
- Status bar indicator and ribbon icon
- Start/Stop/Restart commands
Documentation:
- Comprehensive README with examples
- Quick Start Guide and Implementation Summary
- Test client script
1.3 KiB
1.3 KiB
trigger, description
| trigger | description |
|---|---|
| always_on | Commands and settings implementation guidelines |
Commands & Settings
Commands
- Add user-facing commands via
this.addCommand(...) - Use stable command IDs - Don't rename once released
- Ensure commands are unique and descriptive
Example: Add a Command
this.addCommand({
id: "your-command-id",
name: "Do the thing",
callback: () => this.doTheThing(),
});
Settings
- Provide a settings tab if the plugin has configuration
- Always provide sensible defaults
- Persist settings using
this.loadData()/this.saveData() - Provide defaults and validation in settings
Example: Persist Settings
interface MySettings { enabled: boolean }
const DEFAULT_SETTINGS: MySettings = { enabled: true };
async onload() {
this.settings = Object.assign({}, DEFAULT_SETTINGS, await this.loadData());
await this.saveData(this.settings);
}
Resource Management
- Write idempotent code paths so reload/unload doesn't leak listeners or intervals
- Use
this.register*helpers for everything that needs cleanup
Example: Register Listeners Safely
this.registerEvent(this.app.workspace.on("file-open", f => { /* ... */ }));
this.registerDomEvent(window, "resize", () => { /* ... */ });
this.registerInterval(window.setInterval(() => { /* ... */ }, 1000));