Obsidian MCP Local Server

🚀 Obsidian MCP (Model Context Protocol) Server

This project implements a Model Context Protocol (MCP) server, which is used to connect AI models with the Obsidian knowledge base. Through this server, AI models can perform the following operations: read, create, update, and delete notes, manage folders, and conduct full-text searches.

🚀 Quick Start

Prerequisites

• Node.js v16 or higher
• Obsidian desktop application installed
• Obsidian Local REST API plugin installed and configured

📦 Installation

1. Clone the repository Use the following command to clone the project repository to your local machine:

   git clone https://github.com/yourusername/obsidian-mcp-server.git
   

2. Install dependencies After entering the project directory, run the following command to install the required dependencies:

   npm install
   

3. Build the project After the installation is complete, run the following command to build the project:

   npm run build
   

Configuration

The project configuration is completed through environment variables. Here are the key environment variables that need to be set:

• VAULT_PATH: The storage path of the Obsidian knowledge base.
• API_KEY: The access token for the Obsidian Local REST API.
• PORT: The port number on which the server runs, with a default value of 3000.

An example .env file is as follows:

VAULT_PATH=/path/to/obsidian-vault
API_KEY=your_api_key_here
PORT=3000

⚠️ Important Note

Do not commit the .env file containing sensitive information to the version control system.

💻 Usage Examples

Basic Usage

1. Run directly In the project root directory, run the following command to start the server:

   npm start
   

2. Deploy using Docker If you have built the Docker image, you can use the following command to start the container:

   docker run -it --env-file .env yourusername/obsidian-mcp-server
   

✨ Features

The MCP server provides the following functional modules:

• list_notes: List all notes in the knowledge base.
• read_note: Read the content of a specified note.
• create_note: Create a new note.
• update_note: Update the content of an existing note.
• search_vault: Search for content in the knowledge base.
• delete_note: Delete a specified note.
• manage_folder: Manage folders (including creation, renaming, moving, and deletion operations).

Development

1. Development mode Use the following command to run the server in development mode:

   npm run dev
   

2. Source code structure The source code is located in the src directory. The main files include:
   • server.js: The main server entry file.
   • notes.js and folders.js: Business logic files for handling note and folder operations.

Testing

The project provides a test script to verify the server functionality:

node test-mcp.js

📄 License

ISC

Contribution

Welcome to submit Pull Requests and Issues! We greatly appreciate your contributions.

Related Projects

• Model Context Protocol: The official implementation of the Model Context Protocol.
• Obsidian Local REST API: A local REST API plugin for interacting with the Obsidian knowledge base.