syplugin-anMCPServer

You run a lightweight MCP server that exposes Siyuan Note data to external MCP clients. This server is accessed over HTTP and lets clients perform read and write operations on documents, journals, and related properties through the MCP interface.

How to use

Connect to the MCP server from your MCP client using the HTTP endpoint. The server listens on localhost port 16806 and exposes the MCP API at the /mcp path. Use the access URL http://127.0.0.1:16806/mcp to interact with the server. If your client supports streaming HTTP, you can rely on regular MCP requests over this URL. If your setup requires a streaming response channel, use the appropriate client features to subscribe to updates from the server.

How to install

Prerequisites: you need Node.js installed on your machine. If you do not have Node.js yet, download and install it from the official Node.js website.

# 1) Unzip the plugin package
# 2) Move the folder to the plugin workspace
# 3) Rename the folder to syplugin-anMCPServer

Additional notes

Enable the plugin after placing it in the correct workspace path. The MCP server will listen on 127.0.0.1:16806 by default. Use the server access address http://127.0.0.1:16806/sse for streaming/real-time endpoints if your client supports Server-Sent Events.

Configuration and security

The server currently supports authentication in the newer version. After you enable authentication in the plugin settings, configure your MCP client to send an Authorization header with the value Bearer YourToken.

Troubleshooting

If you cannot reach the MCP endpoint, verify that the plugin is enabled, the server is running on port 16806, and your client is configured to target http://127.0.0.1:16806/mcp. Check logs for any startup errors and confirm the host binding is 127.0.0.1.

Available tools

Search SQL

Query documents and notebooks using SQL-style search and index-backed retrieval.

Notebook Q&A

Interact with notebook content using a Q&A interface backed by an RAG service.

Retrieve by ID

Fetch a document or kramdown by its ID, read properties, and list notebooks.

Backlinks and hierarchy

Get backlinks, child document IDs, and related structural information.

Write operations

Append content to journals or documents by ID, create new documents, and modify properties.

Flashcards

Create flashcards from Markdown content or by block ID and remove flashcards by block ID.