Siyuan MCP Server

🚀 Siyuan Note MCP Server

This project integrates with the Siyuan Note API and supports the Model Context Protocol (MCP), enabling AI models to access context data and execute various commands.

🚀 Quick Start

Environment Variable Configuration

The server requires the following environment variables:

• SIYUAN_TOKEN: Siyuan Note API token (Required)

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 Run

1. Install dependencies:

pnpm install

2. Set environment variables:

# Windows
set SIYUAN_TOKEN=your-siyuan-token

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

3. Start the service:

pnpm start

Docker Run

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

✨ Features

• Integration with Siyuan Note API: Achieve authentication and authorization through the SIYUAN_TOKEN environment variable.
• MCP Protocol Support: Follow the Model Context Protocol (MCP) to provide context data for AI models.
• Command Execution: Support invoking various commands through the MCP protocol, including file operations, network requests, etc.

📦 Installation

Environment Requirements

• Node.js >= 23.10.0
• pnpm

Local Build

pnpm build

Docker Build

docker build -t mcp/siyuan .

📄 License

This project is released under the ISC license. For detailed information, please refer to the LICENSE file in the project repository.

📚 Documentation

• Siyuan Note
• Model Context Protocol
• Siyuan Note API Documentation