English | 中文

这个项目实现了一个 Model Context Protocol (MCP) 服务器，用于连接 AI 模型与 Obsidian 知识库。通过这个服务器，AI 模型可以直接访问和操作 Obsidian 笔记，包括读取、创建、更新和删除笔记，以及管理文件夹结构。

• 与 Obsidian 知识库的无缝集成
• 支持笔记的读取、创建、更新和删除
• 支持文件夹的创建、重命名、移动和删除
• 支持全文搜索功能
• 符合 Model Context Protocol 规范

• Node.js (v16 或更高版本)
• Obsidian 桌面应用
• Obsidian Local REST API 插件 (需要在 Obsidian 中安装)

1. 克隆此仓库：

git clone https://github.com/newtype-01/obsidian-mcp.git
cd obsidian-mcp

2. 安装依赖：

npm install

3. 构建项目：

npm run build

服务器通过环境变量进行配置：

• OBSIDIAN_VAULT_PATH: Obsidian 知识库的路径
• OBSIDIAN_API_TOKEN: Obsidian Local REST API 插件的 API 令牌
• OBSIDIAN_API_PORT: Obsidian Local REST API 插件的端口号 (默认为 27123)

您可以通过以下方式设置环境变量：

1. 复制 .env.example 文件为 .env 并编辑其中的值：

cp .env.example .env

2. 编辑 .env 文件，填入您的实际配置：

OBSIDIAN_VAULT_PATH=/path/to/your/vault
OBSIDIAN_API_TOKEN=your_api_token_here
OBSIDIAN_API_PORT=27123

注意： .env 文件包含敏感信息，已被添加到 .gitignore 中，不会被提交到版本控制系统。

1. 确保 Obsidian 正在运行，并且已安装和配置了 Local REST API 插件

2. 启动 MCP 服务器：

npm start

3. 服务器将通过标准输入/输出与 AI 模型通信

1. 确保已安装 Docker 和 Docker Compose

2. 复制并配置环境文件：

cp .env.example .env

3. 编辑 .env 文件，填入您的实际配置：

OBSIDIAN_VAULT_PATH=/path/to/your/vault
OBSIDIAN_API_TOKEN=your_api_token_here
OBSIDIAN_API_PORT=27123

4. 构建并启动容器：

docker-compose up -d

1. 构建 Docker 镜像：

docker build -t obsidian-mcp .

2. 运行容器：

docker run -d \
  --name obsidian-mcp \
  --env-file .env \
  --network host \
  -v $(OBSIDIAN_VAULT_PATH):$(OBSIDIAN_VAULT_PATH) \
  obsidian-mcp

注意： 使用 Docker 部署时，Docker 容器需要访问主机上的 Obsidian 实例和知识库。确保在 .env 文件中设置了正确的路径和端口，并且使用 network_mode: "host" 或适当的端口映射。

主流 MCP 客户端通常需要编辑配置文件来设置 MCP 服务器。以下是几种常见的配置方式：

{
  "mcpServers": {
    "obsidian-mcp": {
      "command": "npx",
      "args": [
        "obsidian-mcp"
      ],
      "env": {
        // 如果您已经在项目目录中设置了 .env 文件，则可以保留为空
        // 或者您可以直接在这里设置环境变量：
        // "OBSIDIAN_VAULT_PATH": "/path/to/your/vault",
        // "OBSIDIAN_API_TOKEN": "your_api_token_here",
        // "OBSIDIAN_API_PORT": "27123"
      }
    }
  }
}

{
  "mcpServers": {
    "obsidian-mcp": {
      "command": "node",
      "args": [
        "/path/to/obsidian-mcp/build/index.js"
      ],
      "env": {
        // 如果您已经在项目目录中设置了 .env 文件，则可以保留为空
      }
    }
  }
}

如果您已经使用 Docker 部署了 MCP 服务器，您可以通过以下方式配置 MCP 客户端：

{
  "mcpServers": {
    "obsidian-mcp": {
      "command": "docker",
      "args": [
        "exec",
        "-i",
        "obsidian-mcp",
        "npm",
        "start"
      ],
      "env": {
        // Docker 容器已经通过 .env 文件或环境变量配置，此处可以保留为空
      }
    }
  }
}

注意： 上述配置中的 env 部分可以保持为空，特别是当您已经通过 .env 文件或 Docker 环境变量配置了相关参数时。如果您想直接在客户端配置中指定环境变量，则可以在 env 部分填写相应的键值对。

项目包含一个测试脚本，用于验证服务器功能：

node test-mcp.js

MCP 服务器提供以下工具：

• list_notes: 列出知识库中的所有笔记
• read_note: 读取指定笔记的内容
• create_note: 创建新笔记
• update_note: 更新现有笔记
• search_vault: 在知识库中搜索内容
• delete_note: 删除笔记
• manage_folder: 管理文件夹 (创建、重命名、移动、删除)

• 使用 npm run dev 在开发模式下运行服务器
• 源代码位于 src 目录中

ISC

欢迎提交 Pull Requests 和 Issues！

• Model Context Protocol
• Obsidian Local REST API