A
securityA
licenseA
qualityThis TypeScript-based MCP server enables users to manage a simple notes system with capabilities to create and summarize notes through structured prompts and resources.
Last updated -
2
MIT License
The Obsidian MCP Server enables Obsidian vault data access and integration through the Model Context Protocol.
Access Vault Contents: Retrieve structured JSON data of your Obsidian vault through the
get_vault_contentstool, with optional path parameter to target specific directories.Server Information: Get information about the Obsidian server itself.
Metadata Access: Obtain vault metadata alongside content in JSON format.
Development Support: Includes debugging through MCP Inspector and development utilities like auto-rebuild with
npm run watch.
Provides access to Obsidian vault contents, allowing retrieval of vault files and metadata through the 'get_vault_contents' tool. Connects to the Obsidian API to retrieve information about the vault structure and file contents.
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:
src/tool-handlers.ts(76 lines)src/resource-handlers.ts(45 lines)src/server.ts(32 lines)src/api-client.ts(25 lines)
Directory Structure
obsidian-mcp/
├── .codegpt/
│ └── head
├── src/
│ ├── api-client.ts
│ ├── index.ts
│ ├── resource-handlers.ts
│ ├── server.ts
│ └── tool-handlers.ts
├── .SourceSageignore
├── package.json
├── README.md
└── tsconfig.json
Features
Resources
Access Obsidian server info via
obsidian://server-infoURIGet vault contents with metadata
JSON format for easy integration
Tools
get_vault_contents- Retrieve contents of Obsidian vaultTakes path as optional parameter (default: root directory)
Returns structured JSON response
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
# Install dependencies
npm install
# Build the server
npm run build
# Start development server with auto-rebuild
npm run watch
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.json
{
"mcpServers": {
"obsidian-mcp": {
"command": "/path/to/obsidian-mcp/build/index.js",
"env": {
"OBSIDIAN_API_KEY": "your-api-key-here"
}
}
}
}
Debugging
We recommend using the MCP Inspector:
npm run 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
Related MCP Servers
- -security-license-qualityA TypeScript-based MCP server that implements a simple notes system, enabling users to manage text notes with creation and summarization functionalities through structured prompts.
- AsecurityFlicenseAqualityA TypeScript-based MCP server that implements a simple notes system, allowing users to create, access, and generate summaries of text notes.Last updated -123
- AsecurityFlicenseAqualityA TypeScript-based MCP server that implements a simple notes system, allowing users to create, access, and generate summaries of text notes.Last updated -22