siyuan

The Siyuan MCP server provides seamless integration between Claude Desktop and Siyuan Note, leveraging the Model Context Protocol to enhance your note-taking experience. Developers can utilize this server to enable real-time syncing of notes, making it easier to maintain context during interactions with Claude Desktop.

Once connected to the Siyuan MCP server, you can send and receive commands that allow you to retrieve, update, or delete notes within your Siyuan Note collection. You can perform queries such as fetching the latest notes or modifying existing ones, streamlining your workflow while working within Claude Desktop. Ensure your requests adhere to the Model Context Protocol for optimal performance and compatibility.

Prerequisites

Make sure you have Node.js installed on your machine. You can verify your installation by running:

node -v

Option A: Quick start with npx

You can quickly start the Siyuan MCP server using npx with the following command:

npx -y siyuan-mcp-server

Option B: Global install alternative

If you prefer to install it globally, you can clone the repository and run the server manually:

git clone https://github.com/Fromsko/siyuan-mcp-server.git
cd siyuan-mcp-server
npm install
node server.js

When configuring the Siyuan MCP server, ensure that you set the appropriate environment variables for your setup, such as the port number. Be aware of common issues like network permissions that may prevent the server from accepting connections. For a smoother experience, consider running the server in a dedicated terminal session to monitor logs and errors.