A Model Context Protocol server for Obsidian integration
This is a TypeScript-based MCP server that implements integration with Obsidian. It demonstrates core MCP concepts by providing:
- Resources representing Obsidian vault contents
- Tools for accessing vault data
- API integration with Obsidian
Project Statistics
- Total lines of code: 345
- Main files:
Directory Structure
Features
Resources
- Access Obsidian server info via
obsidian://server-infoURI
- Get vault contents with metadata
- JSON format for easy integration
Tools
get_vault_contents- Retrieve contents of Obsidian vault
API Integration
- Secure HTTPS connection with Obsidian API
- Custom axios client with error handling
- Windows path normalization support
Development
Prerequisites
- Node.js v18+
- TypeScript 5.3+
- Obsidian API key (set as OBSIDIAN_API_KEY environment variable)
Setup
Installation
To use with Claude Desktop, add the server config:
On MacOS:
~/Library/Application Support/Claude/claude_desktop_config.json
On Windows: %APPDATA%/Claude/claude_desktop_config.jsonDebugging
We recommend using the MCP Inspector:
The Inspector will provide a URL to access debugging tools in your browser.
Dependencies
Runtime
- @modelcontextprotocol/sdk: MCP server implementation
- axios: HTTP client for API communication
Development
- @types/node: TypeScript definitions for Node.js
- typescript: TypeScript compiler
A Model Context Protocol server for Obsidian integration
This is a TypeScript-based MCP server that implements integration with Obsidian. It demonstrates core MCP concepts by providing:
- Resources representing Obsidian vault contents
- Tools for accessing vault data
- API integration with Obsidian
Project Statistics
- Total lines of code: 345
- Main files:
Directory Structure
Features
Resources
- Access Obsidian server info via
obsidian://server-infoURI
- Get vault contents with metadata
- JSON format for easy integration
Tools
get_vault_contents- Retrieve contents of Obsidian vault
API Integration
- Secure HTTPS connection with Obsidian API
- Custom axios client with error handling
- Windows path normalization support
Development
Prerequisites
- Node.js v18+
- TypeScript 5.3+
- Obsidian API key (set as OBSIDIAN_API_KEY environment variable)
Setup
Installation
To use with Claude Desktop, add the server config:
On MacOS:
~/Library/Application Support/Claude/claude_desktop_config.json
On Windows: %APPDATA%/Claude/claude_desktop_config.jsonDebugging
We recommend using the MCP Inspector:
The Inspector will provide a URL to access debugging tools in your browser.
Dependencies
Runtime
- @modelcontextprotocol/sdk: MCP server implementation
- axios: HTTP client for API communication
Development
- @types/node: TypeScript definitions for Node.js
- typescript: TypeScript compiler