obsidian-mcp

Name: obsidian-mcp
Availability: InStock
Author: Steven Stavrakis

A simple MCP server for Obsidian

GitHub

GitHub Stars

523

User Rating

Not Rated

Favorites

Views

Forks

Issues

Installation

Difficulty

Intermediate

Estimated Time

10-20 minutes

Requirements

Node.js 20以上

Obsidianボールト

Installation

Prerequisites

Node.js: 20 or higher

Obsidian vault

Installation Steps

1. Manual Installation

Add to your Claude Desktop configuration:

macOS: ~/Library/Application Support/Claude/claude_desktop_config.json

Windows: %APPDATA%\Claude\claude_desktop_config.json

json
{
    "mcpServers": {
        "obsidian": {
            "command": "npx",
            "args": ["-y", "obsidian-mcp", "/path/to/your/vault"]
        }
    }
}

Replace /path/to/your/vault with the absolute path to your Obsidian vault. For example: macOS/Linux:

json
"/Users/username/Documents/MyVault"

Windows:

json
"C:\Users\username\Documents\MyVault"

After saving the configuration, restart Claude. You should see the hammer icon appear, indicating the server is connected.

2. Installing via Smithery

bash
npx -y @smithery/cli install obsidian-mcp --client claude

Troubleshooting

If you encounter connection issues, check the logs at:

macOS: ~/Library/Logs/Claude/mcp*.log

Windows: %APPDATA%\Claude\logs\mcp*.log

Configuration

Basic Configuration

Claude Desktop Setup

Edit ~/Library/Application Support/Claude/claude_desktop_config.json (macOS) or %APPDATA%\Claude\claude_desktop_config.json (Windows):

json
{
    "mcpServers": {
        "obsidian": {
            "command": "npx",
            "args": ["-y", "obsidian-mcp", "/path/to/your/vault"]
        }
    }
}

Environment Variables

Set the following environment variables as needed:

bash
export API_KEY="your-api-key"
export DEBUG="true"

Security Settings

Store API keys in environment variables or secure configuration files

Set appropriate file access permissions

Adjust logging levels

Examples

Basic Usage

Using with Claude Desktop

1Verify MCP Server Startup

Open Claude Desktop and confirm that the configuration has been loaded correctly.

2Execute Basic Commands


   Available tools from this MCP server:
   - read-note: Read the contents of a note
   - create-note: Create a new note

Programmatic Usage

javascript
// JavaScript example (Node.js)
const { MCPClient } = require('@modelcontextprotocol/client');

const client = new MCPClient();
await client.connect();

// Execute tool
const result = await client.callTool('read-note', {
  noteId: 'example-note-id'
});

console.log(result);

Advanced Examples

Automation Script

bash
#!/bin/bash
Batch processing example

for file in *.txt; do
  mcp-tool process "$file"
done

API Integration

python
Python example
import requests

def call_mcp_tool(tool_name, params):
    response = requests.post(
        'http://localhost:3000/mcp/call',
        json={
            'tool': tool_name,
            'parameters': params
        }
    )
    return response.json()

Usage example
result = call_mcp_tool('read-note', {'noteId': 'example-note-id'})