syplugin-anMCPServer

siyuan-note 的一个小型 MCP 服务器

中文

为思源笔记提供MCP服务的插件。

✨ 快速入门

• 从市场下载或 1. 解压 Release 中的package.zip ，2. 将文件夹移动到workspace/data/plugins/ ，3. 并将文件夹重命名为syplugin-anMCPServer ；
• 启用插件；
• 该插件默认监听16806端口（Host: 127.0.0.1 ），请使用http://127.0.0.1:16806/sse作为服务器访问地址；

⭐ 如果这对您有帮助，请考虑给它一颗星！

🔧 支持的工具

• [搜索]
  • 使用关键字搜索；
  • 使用 SQL 搜索；
• [取回]
  • 通过 ID 获取文档 kramdown；
  • 列出笔记本；
• [写]
  • 将内容附加到日记；
  • 通过ID将内容附加到特定文档；

❓ 常见问题

• 问：如何在 MCP 客户端中使用它？
  • A：修改MCP应用的配置，选择SSE类型，并配置端点，例如：（以下以chatmcp为例，不同的 MCP 客户端可能需要不同的配置格式，具体请参考 MCP 客户端的文档。）
    { "mcpServers": { "siyuan": { "type": "sse", "command": "http://127.0.0.1:16806/sse", "args": [ "" ], "env": {}, "auto_approve": false } } }
• 问：我的 MCP 客户端不支持基于 HTTP 的通信，仅支持 stdio。
  • 使用支持 HTTP 通信的 MCP Host 应用程序；
  • 或者使用node.js + mcp-remote方案
    npm install -g mcp-remote
    在应用程序中使用类似于下面的配置：（以下以5ire为例，不同的 MCP 客户端可能需要不同的配置格式，具体请参考 MCP 客户端的文档。）
    { "servers": [ { "name": "Siyuan", "key": "siyuan", "description": "Read notes", "command": "npx", "args": [ "mcp-remote", "http://127.0.0.1:16806/sse" ], "isActive": true } ] }
• 问：有哪些常见的 MCP 客户端？
  • 请参考： https://github.com/punkpeye/awesome-mcp-clients或https://modelcontextprotocol.io/clients ；

🙏 参考文献和致谢

一些依赖项在package.json中列出。