How coddingtonbear/obsidian-local-rest-api works
Obsidian Local REST API exposes vault operations through authenticated REST and MCP interfaces. Clients send requests to the plugin’s server; REST handling and MCP tools dispatch vault work, while Obsidian provides vault data and events. Documented capabilities include note CRUD and targeted patching, searching, active-file access, commands, tags, event streams, and file opening. The graph also shows security, extension, and API-description layers. Some subsystems are represented from README claims and the source index; unsampled implementation details and links are omitted.
Main entry points: requestHandler.ts REST routes · main.ts HTTP server · mcpHandler.ts MCP tools · vaultOperations.ts Vault operations
Components 19
Client interfaces
- HTTP server
src/main.ts - REST routes
src/requestHandler.ts - MCP tools
src/mcpHandler.ts - MCP schemas
src/mcpSchema.ts
Vault capabilities
- Vault operations
src/vaultOperations.ts - Vault path guard
src/vaultPath.ts - Targeted patching
src/requestHandler.ts - Vault search
src/vaultOperations.ts - Event streams
src/events.ts - Vault subresources
src/vaultSubresources.ts
Security and state
- Conditional requests
src/conditionalRequests.ts - Signed URLs
src/signedUrls.ts - TLS certificates
src/certificates.ts - Server state
src/serverState.ts
Extension platform
- Extension API
src/publicApi.ts - OpenAPI spec
src/openApiSpec.ts
Other components
- REST clients
- MCP clients
- Obsidian host
Connections 22
- REST clients → HTTP server: sends requests
README.md - MCP clients → HTTP server: connects to
README.md - HTTP server → REST routes: routes requests
src/main.ts - REST routes → Vault operations: delegates vault work
src/requestHandler.ts - MCP tools → Vault operations: invokes operations
src/mcpHandler.ts - MCP tools → MCP schemas: uses schemas
src/mcpHandler.ts - Vault operations → Obsidian host: reads and writes vault
src/vaultOperations.ts - REST routes → Targeted patching: handles patch requests
README.md - REST routes → Vault search: offers search
README.md - REST routes → Event streams: offers event streams
README.md - REST routes → Vault subresources: routes subresources
src/requestHandler.ts - Vault operations → Vault path guard: checks paths
src/vaultOperations.ts - REST routes → Conditional requests: checks conditions
src/requestHandler.ts - MCP tools → Conditional requests: checks preconditions
src/mcpHandler.ts - MCP tools → Signed URLs: creates signed links
src/mcpHandler.ts - Signed URLs → Vault path guard: validates paths
src/signedUrls.ts - HTTP server → TLS certificates: generates certificates
src/main.ts - HTTP server → Server state: uses state limits
src/main.ts - REST routes → Extension API: exposes extensions
src/requestHandler.ts - REST routes → OpenAPI spec: serves API spec
src/requestHandler.ts - Extension API → OpenAPI spec: contributes descriptions
src/openApiSpec.ts - Obsidian host → Event streams: emits vault events
README.md