Gleann MCP 服务器
使用说明(Markdown格式,便于阅读):
-
项目简介 Gleann 的 MCP 服务器是在本仓库中实现的服务器端组件,负责以标准化方式向 LLM 客户端暴露资源、工具和提示模板等能力,并通过 MCP 协议与客户端通信,便于在本地编辑器、RAG 工作流等场景中接入上下文和外部功能。
-
主要功能点
- 注册并暴露 Tools(工具)给客户端使用,如搜索、列表、问答、图谱邻域与文档链接等工具。
- 提供 Resources(资源)接口,允许客户端读取或查询可用的索引资源信息。
- 提供模板/提示相关能力,便于 LLM 在对话中使用预定义的提示模板。
- 采用 MCP 协议进行 JSON-RPC 交互,后端实现了核心的服务端逻辑。
- 支持通过标准输入输出(stdio)传输与客户端通信,便于在编辑器/IDE 集成。
- 集成于 Gleann 生态,配合嵌入式向量检索、图索引和插件系统等模块提供后端能力。
-
安装步骤
- 构建并获取可执行的 Gleann CLI 二进制(包含 MCP 服务器逻辑)。
- 运行 MCP 服务器:在命令行执行 gleann mcp,服务器将启动并监听 MCP 相关交互(通过 stdio 传输,供 MCP 客户端对接)。
- 初始配置(可选):服务器默认使用 Gleann 内置的默认设置(嵌入模型、提供者等),也可以通过 Gleann 的设置/配置文件(如 ~/.gleann/config.json)进行自定义。
- MCP 客户端接入时,需要的配置信息将以 JSON 提供,包含服务器名称、启动命令与参数等信息,用于 MCP 客户端建立连接。
-
服务器配置(示例,MCP 客户端需要的 JSON 配置) { "server_name": "gleann-mcp", "command": "gleann", "args": ["mcp"] } 注释说明:
- server_name: MCP 服务器在客户端侧显示和标识的名称,建议与实际运行的服务名称保持一致,便于日志和排错。
- command: 启动 MCP 服务器的可执行文件名称。
- args: 启动参数列表,当前实现中应包含至少 ["mcp"],以启动嵌入式 MCP 服务。 注:此 JSON 配置仅用于 MCP 客户端对接,MCP 客户端不需要了解服务器内部实现细节,仅需知道启动命令与参数即可建立连接。
-
基本使用方法
- 启动服务器:在命令行执行 gleann mcp,服务器将启动并准备接入 MCP 客户端。
- 客户端交互:通过 MCP 客户端向服务器发送 JSON-RPC 请求,读取资源、调用工具、获取 Prompt 等能力(如执行特定工具、查询资源等),服务器返回 JSON-RPC 响应。
- 会话与能力声明:服务器会维护会话状态和能力声明,支持多种传输场景(尽可能通过 stdio 等本地传输嵌套与集成)。
- 安全与扩展:作为后端框架,服务器设计考虑到资源管理、工具注册及可扩展的提示渲染,便于后续扩展新的工具或资源类型。
-
额外说明
- 该实现直接在仓库内提供服务器端逻辑与 MPI 入口,非单纯的客户端示例,符合 MCP 服务器的职责范畴。
- 若你需要在生产环境中接入,请结合现有 Gleann 的嵌入式向量检索、RAG 与插件生态进行端到端的对接测试。