Agent Chatroom MCP Server
使用说明内容(Markdown格式)
-
项目简介
- 该仓库实现了一个 MCP 服务器,用于在 Claude Code 等环境中实现多代理协作的上下文服务。通过 chatroom MCP 工具集合,代理可以加入聊天室、广播发现、检查最新消息、提出问题并获取答案,以及在结束时离开聊天室。后端核心通过 WebSocket 实现实时消息路由,确保代理和用户之间的协作顺畅。
-
主要功能点
- 暴露的 MCP 工具:chatroom_join、chatroom_leave、chatroom_broadcast、chatroom_ask、chatroom_check、chatroom_who
- 通过 WebSocket 实时路由代理与用户之间的消息
- 连接管理与心跳检测,支持自动重连与 Graceful Shutdown
- 支持多代理共享同一个聊天室的消息缓冲区,便于协作和状态共享
- 提供 MCP 插件/工具的清单查询能力(listTools)
-
安装步骤
- 克隆仓库并进入目录
- 安装依赖:npm install
- 启动 MCP 服务器(示例:node chatroom-mcp.js)
- 启动 WebSocket 服务及相关组件(仓库内的 server.js、start.js、ui.js 等配套组件一起使用)
-
服务器配置 (MCP 客户端连接所需,JSON 配置示例说明)
- 说明:MCP 客户端需要配置一个 MCP 服务器来建立连接。配置内容通常包含服务器名称、启动命令与参数。下方为基于仓库信息的准确描述,非代码片段,仅作示意:
- server: chatroom
- command: node
- args: ["/path/to/claude-agent-chatroom/chatroom-mcp.js"] 注释:这里的路径请替换为实际安装路径。配置项是客户端用于连接此 MCP 服务器所需的最低信息,客户端使用该信息在启动时执行命令以启动并连接到 MCP 服务器。
-
基本使用方法
- 启动后,代理通过 chatroom_join 将自己加入聊天室
- 使用 chatroom_broadcast 分享发现、进度等信息;使用 chatroom_check 获取最新消息与指引
- 如需从其他代理处提问,请使用 chatroom_ask,等待答案
- 工作完成后,通过 chatroom_leave 离开聊天室并结束会话
- 用户端可通过 UI/日志查看实时协作情况,代理端通过 MCP 接口与聊天室交互
-
注意事项
- 请确保服务器端口未被占用,默认 3030
- 环境变量 CHATROOM_PORT、CHATROOM_URL、CHATROOM_USER 可用于配置服务器地址与展示名称
- 服务器支持自动重连、心跳检测和对离线代理的处理,确保健壮性