Conscious Bot MCP 服务器
使用说明(Markdown 格式)
-
项目简介
- 该仓库实现了一个基于 MCP 的服务器端框架,核心职责是对外提供统一的资源、工具、以及 Prompt 模板等能力,以 JSON-RPC 协议与客户端进行通信,支持会话管理、能力声明以及多种传输协议,旨在为 LLM 客户端提供安全、可扩展的上下文服务。
-
主要功能点
- 资源管理:托管与提供可访问的数据资源,支持向 LLM 客户端提供数据访问能力。
- 工具注册与执行:注册 LeafImpl/LeafSpec 等工具接口,支持通过 MCP 通道执行外部功能。
- 提示模板定义与渲染:定义并渲染 Prompt 模板,支持自定义的交互模式。
- JSON-RPC 通信:与客户端以标准的 JSON-RPC 进行请求/响应处理及通知推送。
- 会话管理与能力声明:维护会话上下文、能力集合,以及跨服务的调用权限与审计。
- 多传输协议支持:支持 StdIO、SSE、WebSocket 等传输协议,以适配不同客户端场景。
- 容错与回退:在全量 MCP 服务不可用时提供降级回退方案,确保系统鲁棒性。
-
安装步骤
- 克隆并安装依赖:在项目根目录执行安装命令(如 pnpm install)。
- 启动依赖服务:若使用 Docker/数据库等,请按仓库提供的快速启动脚本准备好底层基础设施。
- 启动 MCP 服务:在回应 MCP 服务的容器或服务中启用 MCP 端点,确保 http(s)://<host>:<port>/mcp 可访问。
- 客户端配置:在 MCP 客户端中配置服务器信息,使其能够通过 MCP 服务器建立连接(见下方的服务器配置示例)。
-
服务器配置(MCP 客户端需要的启动信息) 注:以下配置用于 MCP 客户端在启动时连接 MCP 服务器。配置以 JSON 格式呈现,包含服务器名称、启动命令及参数等说明说明,帮助客户端正确连接 MCP 服务器。实际客户端不需要理解该配置内部实现细节,只需按照该信息启动对应 MCP 服务。
{ "serverName": "ConsciousBot-Planning-MCP", "command": "pnpm", "args": ["--filter", "@conscious-bot/planning", "run", "dev"], "endpoint": "http://localhost:3002/mcp", "description": "嵌入式 MCP 服务器:Planning 服务中的 MCP 端点,提供资源、工具、提示模板等能力的 MCP 服务入口", "permissions": ["read_resources", "register_tools", "execute_tools", "read_prompts"], "notes": "该配置用于 MCP 客户端在连接 MCP 服务器时了解启动方式和端点地址,具体权限与接口细节按 MCP 标准实现,由服务端对接分发能力。" }
-
基本使用方法
- 启动
- 启动 Planning 服务(包含 MCP 服务端能力)后,确保 MCP 端点暴露在 /mcp 路径,并可通过 JSON-RPC 与客户端通信。
- 客户端通过配置的 endpoint 与 MCP 服务器建立连接,注册需要的资源与工具,查询/执行相应的工具或读取提示模板。
- 调用与交互
- 客户端通过 MCP 的标准接口进行资源读取、工具调用、提示模板获取与渲染等操作,服务器返回 JSON-RPC 响应或通知。
- 监控与维护
- 使用仓库提供的健康检查、日志与仪表盘进行运行状态监控,确保 MCP 服务端及依赖组件正常工作。
- 启动