Siyuan Note Taking

🚀 一个为Siyuan笔记提供MCP服务的小插件

该插件专为Siyuan Note提供MCP服务，能有效拓展笔记的功能，提升使用体验。

🚀 快速开始

• 下载插件：你可以从市场直接下载插件，也可以按以下步骤操作：
  1. 下载Release中的package.zip文件；
  2. 将解压后的文件夹移动到workspace/data/plugins/目录下；
  3. 把该文件夹重命名为syplugin-anMCPServer。
• 启用插件：完成下载和重命名后，启用该插件。
• 访问服务器：插件默认监听端口为16806（主机地址为127.0.0.1），请使用http://127.0.0.1:16806/sse作为服务器访问地址。

⭐ 如果该插件对你有帮助，请考虑给它点个星！

✨ 主要特性

支持的工具

• 搜索：
  • 可使用关键词进行搜索。
  • 支持使用SQL语句进行搜索。
• 检索：
  • 能根据ID获取文档内容（kramdown格式）。
  • 可以列出所有笔记本。
• 写入：
  • 可向日记中追加内容。
  • 能根据指定ID向特定文档追加内容。

❓ 常见问题解答

Q: 如何在MCP客户端中使用它？

A: 修改MCP应用程序的配置，选择SSE类型，并配置访问端点，例如：

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

Q: 我的MCP客户端不支持HTTP通信，只支持stdio？

• 可以使用支持HTTP通信的MCP Host应用程序。
• 或者使用node.js + mcp-remote解决方案：

npm install -g mcp-remote

在应用程序中配置类似以下内容：

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

Q: 常见的MCP客户端有哪些？

参考地址：https://github.com/punkpeye/awesome-mcp-clients 或 https://modelcontextprotocol.io/clients。

🙏 参考资料与致谢

部分依赖项已在package.json文件中列出。