Obsidian MCP Rest

🚀 Obsidian MCP REST Server

A server implementing the Model Context Protocol (MCP) that provides access to Obsidian note vaults via a local REST API. This server allows AI assistants to interact with Obsidian notes and manage vault contents through a standardized interface.

🚀 Quick Start

The Obsidian MCP REST Server enables AI assistants to access and manage Obsidian note vaults. Follow the steps below to get started.

✨ Features

• Access Obsidian vault contents via MCP.
• Read and write notes.
• List vault contents.
• Search functionality.
• Secure local REST API integration.
• Compatibility with Claude Desktop and other AI assistants.

📦 Installation

Prerequisites

• Node.js version 16 or higher.
• The Local REST API plugin for Obsidian installed and configured.
• An Obsidian vault with the Local REST API enabled.

Install the package globally:

npm install -g PublikPrinciple/obsidian-mcp-rest

Or use a specific version/branch:

npm install -g PublikPrinciple/obsidian-mcp-rest#main

📚 Configuration

1. Configure the Obsidian Local REST API plugin:

• Install the Local REST API plugin in Obsidian.
• Set the API port (default: 27123).
• Generate and save the API key.

2. Create a configuration file config.json:

{
  "obsidian": {
    "apiKey": "your-api-key-here",
    "port": 27123,
    "host": "localhost"
  },
  "server": {
    "name": "obsidian-mcp",
    "version": "1.0.0"
  }
}

💻 Usage Examples

Basic Usage

1. Start the server:

obsidian-mcp-rest --config path/to/config.json

2. The server will start and listen for MCP requests via stdin/stdout.

Advanced Usage

Integrate with Claude Desktop

1. Configure Claude Desktop to use this MCP server:

• Open Claude Desktop settings.
• Navigate to the MCP section.
• Add a new server configuration:

{
  "name": "obsidian-mcp",
  "command": "obsidian-mcp-rest",
  "args": ["--config", "path/to/config.json"]
}

2. Claude can now access your Obsidian vault using the following commands:

Read the note "Projects/MyProject.md"
List all notes in the "Projects" folder
Search for notes containing "typescript"

📚 Documentation

Available Tools

• listNotes: List all notes in the vault or notes in a specific folder.
• readNote: Read the content of a specific note.
• writeNote: Create or update a note.
• searchNotes: Search for notes that meet specified criteria.
• getMetadata: Get the metadata of a note.

Security Considerations

• All API requests are authenticated using the generated API key.
• The server is restricted to local network access to prevent external access.
• Data remains on the local device and is not uploaded to any server.

Development

1. Clone the repository:

git clone https://github.com/PublikPrinciple/obsidian-mcp-rest.git

2. Navigate to the project directory and install dependencies:

cd obsidian-mcp-rest
npm install

3. Build the project:

npm run build

4. Run tests:

npm test

Troubleshooting

If the installation fails, try manually cloning the repository and running the installation and build commands within it. Also, ensure that Node.js and other dependencies are installed correctly.

Contribution

Pull requests are welcome! For major changes, please discuss them in an issue first to get feedback.

📄 License

This project is licensed under the MIT License. See the LICENSE file for details.