An MCP server for siyuan-note

中文

A plugin that provides MCP service for Siyuan Note.

🌻 Features

• Most tools support the exclude document function.
• It includes certain input parameter validation and is not a direct API wrapper for SiYuan Note.
• Ready to use once the plugin is installed and enabled on the desktop client; Docker and mobile platforms are not supported.

✨ Quick Start

• Download from the marketplace or 1. unzip the package.zip in Release, 2. move the folder to workspace/data/plugins/, 3. and rename the folder to syplugin-anMCPServer;
• Enable the plugin;
• The plugin listens on port 16806 by default (Host: 127.0.0.1), please use http://127.0.0.1:16806/sse as the server access address;

⭐ If this is helpful to you, please consider giving it a star!

🛠 Supported Tools (Summary)

For detailed tools, supported excluded documents, and other notes, please refer to the Supported Tools section.

• Document and block operations: create, read, update, and delete;
• Database operations:
  • Create databases, add/delete/update database rows, add/delete database columns, and retrieve database structure information;
• Attribute operations: create, read, update, and delete;
• Flashcard operations: create flashcards from Markdown content, create flashcards by block ID, delete flashcards by block ID;
• Template operations: retrieve existing templates, get raw template file content, preview template rendering results, preview Sprig rendering results, create or overwrite templates, render templates and insert at the beginning of a document, delete existing templates;
• Notebook operations: list notebooks, rename notebooks;

❓ Frequently Asked Questions

• Q1: How to use it in an MCP client? Please refer to the subsequent sections.

• Q2: What are some common MCP clients?

  • Please refer to: https://github.com/punkpeye/awesome-mcp-clients or https://modelcontextprotocol.io/clients.

• Q3: Does the plugin support authentication?

  • Version v0.2.0 and above support authentication. After setting an authentication token in the plugin settings, you must set the authorization request header in your MCP client with the value Bearer YourToken.

• Q4: Can it be used in Docker?

  • No. The plugin depends on a Node.js environment and does not support running on mobile devices or within Docker.

    To support SiYuan deployed in Docker, it is recommended to switch to other MCP projects. Some projects are listed here.

    Alternatively, you can modify the code to decouple this plugin from the SiYuan frontend.

• Q5: How can I view the configured authorization code?

  • Authorization codes are saved as hashes. You can only modify them; you cannot view the currently active authorization code.

• Q6: When connecting an MCP client, I get an error Invalid Host: x.x.x.x or something similar. How do I fix it?

  {
    "jsonrpc": "2.0",
    "error": {
      "code": -32000,
      "message": "Invalid Host: x.x.x.x"
    },
    "id": null
  }
  

  • By default, for security reasons, the service only handles requests from localhost. If you need to access it via a specific domain or connect to the MCP service in a non-local environment, you must manually declare it in Plugin Settings - Allowed Hosts.
  • Fill in this setting with the corresponding local network IP of the computer or the bound domain name.
  • Simply put: whatever IP or domain name you entered in the MCP client must also be entered here.

• Q7: I only connected once, why does the settings page show a connection count greater than 1?

  • Delayed Statistics: Please click the refresh status button manually to get the latest results.
  • **Connec

... View full README on GitHub