🎉 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
69 lines
1.7 KiB
TypeScript
69 lines
1.7 KiB
TypeScript
import { App, TFile } from 'obsidian';
|
|
import { CallToolResult } from '../types/mcp-types';
|
|
|
|
export class NoteTools {
|
|
constructor(private app: App) {}
|
|
|
|
async readNote(path: string): Promise<CallToolResult> {
|
|
const file = this.app.vault.getAbstractFileByPath(path);
|
|
|
|
if (!file || !(file instanceof TFile)) {
|
|
return {
|
|
content: [{ type: "text", text: `Note not found: ${path}` }],
|
|
isError: true
|
|
};
|
|
}
|
|
|
|
const content = await this.app.vault.read(file);
|
|
return {
|
|
content: [{ type: "text", text: content }]
|
|
};
|
|
}
|
|
|
|
async createNote(path: string, content: string): Promise<CallToolResult> {
|
|
try {
|
|
const file = await this.app.vault.create(path, content);
|
|
return {
|
|
content: [{ type: "text", text: `Note created successfully: ${file.path}` }]
|
|
};
|
|
} catch (error) {
|
|
return {
|
|
content: [{ type: "text", text: `Failed to create note: ${(error as Error).message}` }],
|
|
isError: true
|
|
};
|
|
}
|
|
}
|
|
|
|
async updateNote(path: string, content: string): Promise<CallToolResult> {
|
|
const file = this.app.vault.getAbstractFileByPath(path);
|
|
|
|
if (!file || !(file instanceof TFile)) {
|
|
return {
|
|
content: [{ type: "text", text: `Note not found: ${path}` }],
|
|
isError: true
|
|
};
|
|
}
|
|
|
|
await this.app.vault.modify(file, content);
|
|
return {
|
|
content: [{ type: "text", text: `Note updated successfully: ${path}` }]
|
|
};
|
|
}
|
|
|
|
async deleteNote(path: string): Promise<CallToolResult> {
|
|
const file = this.app.vault.getAbstractFileByPath(path);
|
|
|
|
if (!file || !(file instanceof TFile)) {
|
|
return {
|
|
content: [{ type: "text", text: `Note not found: ${path}` }],
|
|
isError: true
|
|
};
|
|
}
|
|
|
|
await this.app.vault.delete(file);
|
|
return {
|
|
content: [{ type: "text", text: `Note deleted successfully: ${path}` }]
|
|
};
|
|
}
|
|
}
|