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 文檔