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
38 lines
1.0 KiB
Markdown
38 lines
1.0 KiB
Markdown
---
|
|
trigger: always_on
|
|
description: Development environment and tooling requirements
|
|
---
|
|
|
|
# Environment & Tooling
|
|
|
|
## Required Tools
|
|
|
|
- **Node.js**: Use current LTS (Node 18+ recommended)
|
|
- **Package manager**: npm (required for this sample - `package.json` defines npm scripts and dependencies)
|
|
- **Bundler**: esbuild (required for this sample - `esbuild.config.mjs` and build scripts depend on it)
|
|
- **Types**: `obsidian` type definitions
|
|
|
|
**Note**: This sample project has specific technical dependencies on npm and esbuild. If creating a plugin from scratch, you can choose different tools, but you'll need to replace the build configuration accordingly. Alternative bundlers like Rollup or webpack are acceptable if they bundle all external dependencies into `main.js`.
|
|
|
|
## Common Commands
|
|
|
|
### Install dependencies
|
|
```bash
|
|
npm install
|
|
```
|
|
|
|
### Development (watch mode)
|
|
```bash
|
|
npm run dev
|
|
```
|
|
|
|
### Production build
|
|
```bash
|
|
npm run build
|
|
```
|
|
|
|
## Linting
|
|
|
|
- Install eslint: `npm install -g eslint`
|
|
- Analyze project: `eslint main.ts`
|
|
- Analyze folder: `eslint ./src/` |