Onigeya Siyuan MCP Server

🚀 SiYuan Note MCP Server Implementation

This is a Node.js-based implementation of the MCP (Model Context Protocol) server for the SiYuan note system. Through this server, AI models such as Claude can be seamlessly integrated with the SiYuan note system.

✨ Features

• Supports identity authentication by configuring SIYUAN_TOKEN through environment variables.
• Provides a complete list of commands to support interaction with the SiYuan note system.
• Supports local running and Docker containerized deployment.
• Licensed under the ISC license.

📚 Documentation

Environment Variable Configuration

The server requires the following environment variables:

• SIYUAN_TOKEN: SiYuan note API token (required).
  • How to obtain: Check in SiYuan note settings - About.
  • Purpose: Used for API authentication.

Usage in Claude Desktop

Add the following configuration to claude_desktop_config.json:

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

Local Running

1. Install dependencies:

pnpm install

2. Set environment variables:

# Windows system
set SIYUAN_TOKEN=your-siyuan-token

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

3. Start the service:

pnpm start

Docker Running

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

📦 Installation

Environment Requirements

• Node.js version >= 23.10.0
• pnpm

Local Build

pnpm build

Docker Build

docker build -t mcp/siyuan .

📄 License

This project is released under the ISC license. This means you can freely use, modify, and distribute this software, but you must comply with the terms and conditions of the ISC license. For detailed information, please refer to the LICENSE file in the project repository.

🔗 Related Resources

• SiYuan Note
• Model Context Protocol
• SiYuan Note API Documentation