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
27 lines
988 B
Markdown
27 lines
988 B
Markdown
---
|
|
description: Agent-specific do's and don'ts
|
|
---
|
|
|
|
# Agent Guidelines
|
|
|
|
## Do
|
|
|
|
- Add commands with stable IDs (don't rename once released)
|
|
- Provide defaults and validation in settings
|
|
- Write idempotent code paths so reload/unload doesn't leak listeners or intervals
|
|
- Use `this.register*` helpers for everything that needs cleanup
|
|
- Keep `main.ts` minimal and focused on lifecycle management
|
|
- Split functionality across separate modules
|
|
- Organize code into logical folders (commands/, ui/, utils/)
|
|
|
|
## Don't
|
|
|
|
- Introduce network calls without an obvious user-facing reason and documentation
|
|
- Ship features that require cloud services without clear disclosure and explicit opt-in
|
|
- Store or transmit vault contents unless essential and consented
|
|
- Put all code in `main.ts` - delegate to separate modules
|
|
- Create files larger than 200-300 lines without splitting them
|
|
- Commit build artifacts to version control
|
|
- Change plugin `id` after release
|
|
- Rename command IDs after release
|