siyuan-mcp-server

🚀 思源笔记 MCP 服务器

思源笔记 MCP 服务器可与思源笔记 API 集成，遵循 MCP 协议为 AI 模型提供上下文数据，还支持通过 MCP 协议调用各类命令，如文件操作、网络请求等。

✨ 主要特性

• 与思源笔记 API 的集成：通过 SIYUAN_TOKEN 环境变量实现身份验证和授权。
• MCP 协议支持：遵循 Model Context Protocol (MCP)，为 AI 模型提供上下文数据。
• 命令执行：支持通过 MCP 协议调用各种命令，包括文件操作、网络请求等。

📦 安装指南

环境要求

• Node.js >= 23.10.0
• pnpm

本地安装

1. 安装依赖：

pnpm install

2. 设置环境变量：

# Windows
set SIYUAN_TOKEN=your-siyuan-token

# Linux/macOS
export SIYUAN_TOKEN=your-siyuan-token

3. 启动服务：

pnpm start

Docker 安装

docker run --rm -i \
  -e SIYUAN_TOKEN=your-siyuan-token \
  mcp/siyuan

💻 使用示例

基础用法

环境变量配置

服务器需要以下环境变量：

• SIYUAN_TOKEN：思源笔记 API 令牌（必需）

在 Claude Desktop 中使用

将以下配置添加到 claude_desktop_config.json：

{
  "mcpServers": {
    "siyuan": {
      "command": "npx",
      "args": [
        "-y",
        "@onigeya/siyuan-mcp-server"
      ],
      "env": {
        "SIYUAN_TOKEN": "your-siyuan-token"
      }
    }
  }
}

📚 详细文档

构建

本地构建

pnpm build

Docker 构建

docker build -t mcp/siyuan .

📄 许可证

本项目基于 ISC 许可证发布。详细信息请参见项目仓库中的 LICENSE 文件。

🔗 相关资源

• 思源笔记
• Model Context Protocol
• 思源笔记 API 文档