直接使用

Skip to content

You signed in with another tab or window. Reload
to refresh your session. You signed out in another tab or window. Reload
to refresh your session. You switched accounts on another tab or window. Reload
to refresh your session. Dismiss alert

newtype-01 / obsidian-mcp Public

• Notifications
  You must be signed in to change notification settings

• Fork 0

• Star 9

Obsidian MCP (Model Context Protocol) 服务器

9 stars
0 forks
Branches
Tags
Activity

Star

Notifications
You must be signed in to change notification settings

newtype-01/obsidian-mcp

main

1 Branch
0 Tags

Go to file

Code

Folders and files

| Name | | Name | Last commit message | Last commit date |
| --- | --- | --- | --- |
| Latest commit
-------------



Yihe Huang

and

Yihe Huang

添加Docker部署方法和MCP客户端配置说明

Mar 29, 2025

a631e83
 · Mar 29, 2025

History
-------

3 Commits

| | |
| src | | src | 初始提交：Obsidian MCP服务器 | Mar 13, 2025 |
| .dockerignore | | .dockerignore | 添加Docker部署方法和MCP客户端配置说明 | Mar 29, 2025 |
| .env.example | | .env.example | 初始提交：Obsidian MCP服务器 | Mar 13, 2025 |
| .gitignore | | .gitignore | 初始提交：Obsidian MCP服务器 | Mar 13, 2025 |
| Dockerfile | | Dockerfile | 添加Docker部署方法和MCP客户端配置说明 | Mar 29, 2025 |
| README.en.md | | README.en.md | 添加Docker部署方法和MCP客户端配置说明 | Mar 29, 2025 |
| README.md | | README.md | 添加Docker部署方法和MCP客户端配置说明 | Mar 29, 2025 |
| docker-compose.yml | | docker-compose.yml | 添加Docker部署方法和MCP客户端配置说明 | Mar 29, 2025 |
| package-lock.json | | package-lock.json | 初始提交：Obsidian MCP服务器 | Mar 13, 2025 |
| package.json | | package.json | 初始提交：Obsidian MCP服务器 | Mar 13, 2025 |
| tsconfig.json | | tsconfig.json | 初始提交：Obsidian MCP服务器 | Mar 13, 2025 |
| View all files | | |

Repository files navigation

Obsidian MCP (Model Context Protocol) 服务器

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

1. 安装依赖：

npm install

1. 构建项目：

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

1. 编辑 .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

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

使用 Docker 部署

使用 Docker Compose (推荐)

1. 确保已安装 Docker 和 Docker Compose

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

cp .env.example .env

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

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

2. 构建并启动容器：

docker-compose up -d

使用 Docker 命令

1. 构建 Docker 镜像：

docker build -t obsidian-mcp .

1. 运行容器：

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 客户端通常需要编辑配置文件来设置 MCP 服务器。以下是几种常见的配置方式：

使用 npx 方式

{
  "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 方式

如果您已经使用 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

About

Obsidian MCP (Model Context Protocol) 服务器

Resources

Readme

Activity

Stars

9 stars

Watchers

1 watching

Forks

0 forks

Report repository

Releases

No releases published

Packages 0

No packages published

Languages

• JavaScript 98.6%

• Dockerfile 1.4%

You can’t perform that action at this time.