syplugin-anMCPServer

# 一个MCP服务端插件 > 为[思源笔记](https://github.com/siyuan-note/siyuan)提供MCP服务的插件。 > 当前版本: v0.5.1 > > 修复：关于历史记录页面的若干问题；改进：块操作工具及返回值； > > 其他详见[更新日志](./CHANGELOG.md)。 ## ✨快速开始 - 从集市下载 或 1、解压Release中的`package.zip`，2、将文件夹移动到`工作空间/data/plugins/`，3、并将文件夹重命名为`syplugin-anMCPServer`; - 开启插件； - 打开插件设置，启动服务； - 插件默认监听`16806`端口（Host: `127.0.0.1`），请使用`http://127.0.0.1:16806/mcp`作为服务端访问地址； > ⭐ 如果这对你有帮助，请考虑点亮Star！ ## 🔧支持的工具 - 【检索】 - ~~使用关键词搜索；~~ > 目前来看，在需要SQL动态检索时，大模型仍然使用此工具。暂时移除，如有需要请反馈 - 使用SQL搜索； - ~~笔记索引库问答（使用RAG后端服务，[功能测试中](./RAG_BETA.md)）；~~ > 此功能即将被移除 - 【获取】 - 通过id获取文档markdown； - 通过id获取块kramdown； - 列出笔记本； - 通过id获取反向链接； - 获取文档的子文档列表； - 读取属性； - ~~读取指定日期日记；~~ > 暂时移除，如有需要请反馈 - 【写入】 - 文档类 - 向日记追加内容； - 通过id向指定文档追加内容； - 通过id在指定位置创建新文档； - 插入子块；（前置插入/后置插入） - 插入块；（指定位置） - 更新块； - 闪卡类 - 通过Markdown内容创建闪卡； - 通过块id创建闪卡； - 通过块id删除闪卡； - 属性 - 更改属性；（增删改） ## ❓可能常见的问题 - Q: 如何在MCP客户端中使用？ 请参考后文； - Q: 常见的MCP客户端有哪些？ - 请参考：https://github.com/punkpeye/awesome-mcp-clients 或 https://modelcontextprotocol.io/clients ； - Q：插件支持鉴权吗？ - v0.2.0版本已支持鉴权，在插件设置处设置鉴权token后，在MCP客户端，需要设置`authorization`请求头，其值为 `Bearer 你的Token`； - Q：连接数是什么？ - 在SSE方式下，这代表了仍在保持状态的连接数量，由于客户端未正确断开连接、其他未知软件连入等原因，连接数可能有变动； - 在Streamable HTTP方式下，插件将在请求结束后断开连接，连接数始终为0，后期版本将不再展示连接数； - Q: 可以在docker使用吗？ - 不可以，插件依赖nodejs环境，不支持在移动端、docker运行； > 若要支持docker中部署的思源，建议转为使用其他MCP项目，部分项目可能在[这里](https://github.com/siyuan-note/siyuan/issues/13795)列出； > > 或者，修改代码，将本插件和思源前端解耦； - Q: 如何查看已经设置的授权码？ - 授权码哈希后保存，只能修改，不能查看生效中的授权码； - Q：什么是“笔记索引库问答（使用RAG后端服务）”工具？ - “笔记索引库问答”是一种基于 RAG（Retrieval-Augmented Generation，检索增强生成）技术的问答工具。该工具允许语言模型在回答问题时，引用已被索引的笔记内容，确保生成的回答更加准确； - 参考[RAG_BETA文档](./RAG_BETA.md)正确部署并在插件设置 “插件RAG后端：请求baseURL” 之后，可以在文档树右键-插件选择索引文档，文档将发送到 RAG后端 进行索引（目前的实现使用对 [LightRAG](https://github.com/HKUDS/LightRAG) 简单包装的python后端）； - 语言模型在用户提问时，可以调用该工具，获取基于 LightRAG 知识图谱给出的回答； - 注意：回答仅基于已被索引的文档，不会使用未被索引的文档内容。 ## ✅如何在MCP客户端中配置？ > MCP客户端不断迭代更新，这里的配置或使用说明未必能够直接套用，仅供参考； > > 这里假设：插件设置的端口号为 `16806`，授权码为 `abcdefg`，请以实际填写的插件设置为准。 修改MCP应用的配置，选择`Streamable HTTP`类型，并配置端点。 ### 支持Streamable HTTP类型的客户端 下面的配置以 [Cherry Studio](https://github.com/CherryHQ/cherry-studio) 为例，针对不同的MCP客户端，可能需要不同的配置格式，请以MCP客户端文档为准。 **插件未设置授权码** 1. 类型：选择 可流式传输的HTTP（streamablehttp）； 2. URL：`http://127.0.0.1:16806/mcp`； 3. 请求头：空； **插件已设置授权码** 1. 类型：选择 可流式传输的HTTP（streamablehttp）； 2. URL：`http://127.0.0.1:16806/mcp`； 3. 请求头：`Authorization=Bearer abcedfg`； > 这里假设：插件设置的端口号为 `16806`，授权码为 `abcdefg`，请以实际填写的插件设置为准。 ### 仅支持stdio的客户端 若MCP客户端不支持基于HTTP的通信方式，仅支持stdio，则需要通过转换后使用。 这里使用`node.js` + `mcp-remote@next`的方案。 1. 下载nodejs https://nodejs.org/zh-cn/download 2. 安装mcp-remote@next ```bash npm install -g mcp-remote@next ``` 下面的配置以 [5ire](https://5ire.app/) 为例，针对不同的MCP客户端，可能需要不同的配置格式，请以MCP客户端文档为准。 **插件未设置授权码** 命令： ``` npx mcp-remote@next http://127.0.0.1:16806/mcp ``` **插件已设置授权码** 命令： ``` npx mcp-remote@next http://127.0.0.1:16806/mcp --header Authorization:${AUTH_HEADER} ``` 环境变量： 名称：`AUTH_HEADER` 值：`Bearer abcdefg` > 这里假设：插件设置的端口号为 `16806`，授权码为 `abcdefg`，请以实际填写的插件设置为准。 ## 🙏参考&感谢 > 部分依赖项在`package.json`中列出。 | 开发者/项目 | 项目描述 | 引用方式 | |---------------------------------------------------------------------|----------------|--------------| | [thuanpham582002/tabby-mcp-server](https://github.com/thuanpham582002/tabby-mcp-server) | 在终端软件Tabby中提供MCP服务； MIT License | MCP服务实现方式 | | [wilsons](https://ld246.com/article/1756172573626/comment/1756384424179?r=wilsons#comments) / [Frostime](https://ld246.com/article/1739546865001#%E6%80%9D%E6%BA%90-SQL-%E6%9F%A5%E8%AF%A2-System-Prompt) | 提示词/系统提示词 CC BY-SA 4.0 | 系统提示词等，位于项目的`static/`目录 |