llms-full-unbind MCP 服务器
使用说明(Markdown格式)
- 项目简介
- 该仓库实现了一个基于 Model Context Protocol (MCP) 的后端服务器,核心功能是向 LLM 客户端提供上下文相关资源和工具。具体实现中,服务器读取 llms-full-unbind 包对 llms-full.txt 文件格式进行解析,建立文档索引,并暴露两个工具供客户端调用:
- read_doc:按路径读取文档内容
- search_doc:基于查询对文档进行检索
- 该仓库实现了一个基于 Model Context Protocol (MCP) 的后端服务器,核心功能是向 LLM 客户端提供上下文相关资源和工具。具体实现中,服务器读取 llms-full-unbind 包对 llms-full.txt 文件格式进行解析,建立文档索引,并暴露两个工具供客户端调用:
- 主要功能点
- MCP 服务器核心:提供能力声明,支持通过传输通道(如 Stdio)与客户端进行 JSON-RPC 交互。
- 工具(Tools):注册并实现两个工具 read_doc 与 search_doc,定义输入输出的 JSON Schema,确保客户端可以根据需求读取文本、执行检索。
- 文档索引:基于 llms-full-unbind 提供的解析能力,构建对 llms-full.txt 的索引,使得查询能快速定位相关文档。
- 传输多样性:通过 StdioServerTransport 等方式,支持直连式、流式等多种传输场景,方便在不同环境下接入客户端。
- 安装步骤(通用)
- 安装依赖:在项目根目录执行依赖安装,确保 Node.js 环境就绪。
- 构建与打包:编译 llms-full-unbind-mcp 包,产生可执行的服务器组件。
- 启动服务器:使用该包提供的命令行界面 (CLI) 启动 MCP 服务器,并给出 llms-full.txt 文件的 URL 列表作为参数。例如启动时传入一个或多个 llms-full.txt 的 URL,服务器将据此建立文档索引并开放工具接口。
- 客户端连接:MCP 客户端通过 MCP 的标准 JSON-RPC 调用与服务器交互,请求读取文档内容或执行文档检索等操作。
- 服务器配置(MCP 客户端必需的最小信息)
- 服务器名称(name): llms-full-unbind-mcp
- 启动命令(command): llms-full-unbind-mcp(或对应的启动脚本,如打包后的可执行文件名)
- 参数(args): 包含 llms-full.txt 文件的 URL 列表,例如 ["https://example.com/llms-full.txt"]
- 说明:此配置用于 MCP 客户端在建立连接前了解服务器的名称、如何启动以及所需要的参数。MCP 客户端本身并不需要包含具体实现细节,它只需要知道以上关键信息以便建立连接和调用工具。
- 基本使用方法
- 启动服务器后,客户端即可通过 JSON-RPC 请求调用工具:
- read_doc:传入文档路径,服务器返回文档内容的文本块及元数据。
- search_doc:传入查询字符串或正则表达式,服务器返回匹配的文档列表及相关信息(如路径、匹配词、分数)。
- 使用示例(简述,非代码):
- 调用 read_doc,传入要读取的文档路径,获取对应文本内容。
- 调用 search_doc,传入查询词(或正则表达式),获取相关文档的匹配结果与排序分数。
- 运行特点:
- 服务器将对 llms-full.txt 进行解析、索引与查询,支持大文件的流式处理,便于在资源消耗受限的环境中工作。
- 启动服务器后,客户端即可通过 JSON-RPC 请求调用工具: