Siyuan Note Taking

🚀 A Small Plugin Providing MCP Service for Siyuan Note

This plugin provides MCP service for Siyuan Note.

🚀 Quick Start

• Download the plugin from the marketplace. Alternatively, you can: 1. Download the package.zip file from the Release. 2. Move the unzipped folder to the workspace/data/plugins/ directory. 3. Rename the folder to syplugin-anMCPServer.
• Enable the plugin.
• The plugin listens on port 16806 by default (with the host address 127.0.0.1). Please use http://127.0.0.1:16806/sse as the server access address.

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

✨ Features

Supported Tools

• [Search]
  • Search using keywords.
  • Search using SQL statements.
• [Retrieval]
  • Get document content (in kramdown format) by ID.
  • List all notebooks.
• [Writing]
  • Append content to the diary.
  • Append content to a specific document by the specified ID.

❓ FAQs

Q: How to use it in an MCP client?

• A: Modify the configuration of the MCP application, select the SSE type, and configure the access endpoint. For example:

{
    "mcpServers": {
        "siyuan": {
            "type": "sse",
            "command": "http://127.0.0.1:16806/sse",
            "args": [
                ""
            ],
            "env": {},
            "auto_approve": false
        }
    }
}

Q: My MCP client only supports stdio and does not support HTTP communication. What should I do?

• You can use an MCP Host application that supports HTTP communication.
• Or use the node.js + mcp-remote solution:

npm install -g mcp-remote

Configure the following content in the application:

{
    "servers": [
        {
            "name": "Siyuan",
            "key": "siyuan",
            "description": "Read notes",
            "command": "npx",
            "args": [
                "mcp-remote",
                "http://127.0.0.1:16806/sse"
            ],
            "isActive": true
        }
    ]
}

Q: What are some common MCP clients?

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

🙏 References and Acknowledgments

Some dependencies are listed in the package.json file.