Obsidian MCP

🚀 Obsidian-MCP MCP Server

This is a TypeScript-based MCP server integrated with Obsidian, demonstrating core MCP concepts.

🚀 Quick Start

The Obsidian-MCP MCP Server is a TypeScript project integrated with Obsidian. It showcases key MCP concepts and provides various functionalities for interacting with Obsidian vaults.

✨ Features

Resources

• Access Obsidian server information via the obsidian://server-info URI.
• Retrieve vault contents and their metadata.
• Support JSON format for easy integration.

Tools

• get_vault_contents: Retrieve the contents of an Obsidian vault.
  • Accepts a path as an optional parameter (default: root directory).
  • Returns a structured JSON response.

API Integration

• Establish a secure connection with the Obsidian API over HTTPS.
• Utilize a custom axios client with error handling.
• Support Windows path normalization.

📦 Installation

To use with Claude Desktop, add the server configuration:

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"
      }
    }
  }
}

💻 Usage Examples

Basic Usage

The following steps show how to set up and run the server:

# Install dependencies
npm install

# Build the server
npm run build

# Start the development server with auto-rebuild
npm run watch

Advanced Usage

To use the server with Claude Desktop, follow the installation steps above. You can then interact with the Obsidian vault through the provided API endpoints.

📚 Documentation

Project Overview

This is a TypeScript-based MCP server integrated with Obsidian. It demonstrates the following core MCP concepts:

• Resource representation based on Obsidian vault contents.
• Tools for accessing vault data.
• Integration with the Obsidian API.

Project Statistics

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

Development

Prerequisites

• Node.js v18+
• TypeScript 5.3+
• Obsidian API key (set as the OBSIDIAN_API_KEY environment variable)

Debugging

We recommend using MCP Inspector:

npm run inspector

The Inspector will provide a URL to access the debugging tools in your browser.

🔧 Technical Details

Dependencies

Runtime

• @modelcontextprotocol/sdk: MCP server implementation
• axios: HTTP client for API communication

Development

• @types/node: TypeScript definitions for Node.js
• typescript: TypeScript compiler