onigeya_siyuan-mcp-server

🚀 SiYuan 笔记 MCP 服务器实现

这是一个基于 Node.js 的 SiYuan 笔记系统 MCP（Model Context Protocol）服务器实现。借助该服务器，能够让 Claude 等 AI 模型与 SiYuan 笔记系统实现无缝集成。

🚀 快速开始

本项目可将 AI 模型与 SiYuan 笔记系统集成，下面为你介绍不同方式的启动步骤。

✨ 主要特性

• 支持通过环境变量配置 SIYUAN_TOKEN 实现身份认证。
• 提供完整的命令列表，支持与 SiYuan 笔记系统交互。
• 支持本地运行和 Docker 容器化部署。
• 开源协议为 ISC 许可证。

📦 安装指南

环境变量配置

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

• SIYUAN_TOKEN：SiYuan 笔记 API 令牌（必填）
  • 获取方式：在 SiYuan 笔记设置 - 关于 中查看。
  • 用途：用于 API 认证。

在 Claude Desktop 中使用

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

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

本地运行

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

📚 详细文档

构建指南

环境要求

• Node.js 版本 >= 23.10.0
• pnpm

本地构建

pnpm build

Docker 构建

docker build -t mcp/siyuan .

📄 许可证

本项目基于 ISC 许可证发布。这意味着您可以自由使用、修改和分发本软件，但需遵守 ISC 许可证的条款和条件。详细信息请参阅项目仓库中的 LICENSE 文件。

🔗 相关资源

• SiYuan 笔记
• Model Context Protocol
• SiYuan 笔记 API 文档