Obsidian MCP Server R3c

🚀 OBSIDIAN-MCP-SERVER

A Model Context Protocol (MCP) Stdio server for interfacing with LLM Agents. This server provides Python-based Obsidian-related functionalities for LLM Agents, enabling them to leverage Obsidian's capabilities.

🚀 Quick Start

This server offers a range of functions for managing knowledge bases and files in Obsidian. Below are the installation and usage steps.

✨ Features

Knowledge Base Management

• Create a knowledge base
• Delete a knowledge base
• Query the list of knowledge bases
• Query knowledge base information
• Query knowledge base settings
• Change knowledge base settings

File Management

• Query the list of files in a knowledge base
• Create (new/edit) a file in a knowledge base
• Delete a file in a knowledge base

📦 Installation

1. Clone the repository

git clone https://github.com/your-username/obsidian-mcp-server.git
cd obsidian-mcp-server

2. Create and activate a virtual environment

python -m venv venv
source venv/bin/activate  # For Linux/Mac systems
# Or
.\venv\Scripts\activate  # For Windows systems

3. Install dependencies

pip install -r requirements.txt

4. Configure environment variables Create a .env file and add the following content:

OBSIDIAN_VAULT_PATH=/path/to/your/obsidian/vault

💻 Usage Examples

Start the server

python main.py

API Usage Examples

Create a knowledge base

{
    "jsonrpc": "2.0",
    "method": "create_vault",
    "params": {
        "vault_name": "my_vault",
        "path": "/optional/custom/path"
    },
    "id": 1
}

Query the list of knowledge bases

{
    "jsonrpc": "2.0",
    "method": "list_vaults",
    "params": {},
    "id": 2
}

Create a file

{
    "jsonrpc": "2.0",
    "method": "write_vault_file",
    "params": {
        "vault_name": "my_vault",
        "file_path": "notes/example.md",
        "content": "# Example Note\n\nThis is a test note."
    },
    "id": 3
}

📚 Documentation

Error Codes

• -32000: General error
• -32001: Knowledge base not found
• -32002: Knowledge base already exists
• -32003: File not found
• -32004: Path not found
• -32005: Settings file not found
• -32006: Configuration error
• -32007: File operation error
• -32008: Request error
• -32009: Environment variable configuration error
• -32010: Obsidian directory error

Response Formats

Successful Response

{
    "jsonrpc": "2.0",
    "id": 1,
    "result": {
        "status": "success",
        "message": "Vault created successfully"
    }
}

Failed Response

{
    "jsonrpc": "2.0",
    "id": 1,
    "error": {
        "code": -32001,
        "message": "Vault not found"
    }
}

📄 License

[Insert license content here]

Cursor Installation Steps

To use this server with Cursor, add the following configuration to config.json:

{
    "mcp_server": {
        "command": "/path/to/venv/bin/python",
        "script_path": "/path/to/main.py"
    }
}

Ensure that:

1. /path/to/venv/bin/python is the path to the Python executable for running the MCP server.
2. /path/to/main.py is the path to the main script of the MCP server.