The Agents MCP 服务器
使用说明(Markdown 格式)
-
项目简介
- 该仓库实现了一个基于 MCP(Model Context Protocol)的后端服务器,用来为大模型客户端提供统一的上下文服务。它通过 JSON-RPC 与客户端通信,核心职责包括资源(Assets/Boards/Inboxes 等)的托管与访问、Tools 的注册与执行、以及 Prompt 模板的渲染与管理,同时支持通过 HTTP 与 STDIO 两种传输方式,便于在不同运行环境中接入。
-
主要功能点
- MCP 核心能力:创建并运行一个 MCP 服务器,注册多种工具,处理来自客户端的请求与响应。
- 资源与资产管理:提供诸如列出资产、添加/删除资产、移动资产、附加内容、读取板块与内容等工具。
- 提示与模板支持:通过工具实现对 Prompts/模板的渲染和使用,便于 LLM 与系统协同工作。
- 工具集成与执行:提供一整套工具集(如订阅信号、检查信箱、任务/队列、看板、资产、接待、事件等),支持操作 Hub 的资源与任务流。
- 多传输协议:支持通过 HTTP(REST + WebSocket 等)或 STDIO 进行 MCP 通信,灵活适配容器化与本地开发环境。
- 安全与鉴权:可通过 API Key、OAuth 路由等方式实现对接口的访问控制。
- Hub 集成:服务器主动向 The Agents Hub 报告状态、获取属性、推送事件,形成端到端的工作流闭环。
- 多代理支持:一个服务器实例可以为多个代理注册不同的环境变量(如 AGENT_NAME、AGENT_SPRITE)并在 hub 上体现为不同的实体。
-
安装步骤
- 安装运行环境:请先安装 Node.js(推荐版本与项目要求相符,通常 Node.js 16+)。
- 获取代码与依赖:将仓库克隆到本地,执行安装依赖。
- 构建/编译(若使用 TypeScript 源码):执行构建步骤将 TypeScript 转换为可直接运行的 JavaScript。
- 启动 MCP 服务器:运行打包后的入口程序(dist/index.js)或通过 npm 包直接启动。仓库提供了两种接入方式:HTTP 传输与 STDIO 传输,任选其一。
- 启动 The Agents Hub(Hub 服务端):若要与 Hub 交互,请确保 Hub 服务已在本地或网络可访问。
- 配置 .mcp.json:在你的项目中添加 MCP 配置,使客户端 MCP 能正确启动并连接到服务器。
-
服务器配置(示例字段说明,非代码块,仅作字段解释) 配置文件示例(JSON 结构,注释为说明文字) { "mcpServers": { "agent-visualizer": { "command": "npx", "args": ["the-agents-mcp"], "env": { "HUB_URL": "http://localhost:4242", "AGENT_NAME": "Claude", "AGENT_SPRITE": "Yuki" } } } } 字段说明:
- mcpServers: MCP 服务器集合,每个键为服务器实例名称。
- agent-visualizer: 具体服务器实例名称(可自定义,示例名称)。
- command: 启动服务器时使用的命令,这里使用 npx。
- args: 传递给命令的参数,确保能够执行本仓库中的 MCP 服务器实现。
- env: 运行时环境变量,用于与 Hub 的交互、代理信息等配置。
- HUB_URL: The Agents Hub 的地址,默认通常是 http://localhost:4242。
- AGENT_NAME: 代理在系统中的显示名。
- AGENT_SPRITE: 代理的外观/形象标识(可选)。 注:MCP 客户端无需此处提供客户端代码,这里仅描述服务器端的启动配置。
-
基本使用方法
- 启动 The Agents Hub 服务端(如果尚未运行)。
- 在你的项目根目录添加上述 .mcp.json 配置(或使用你已有的配置形式)。
- 启动 MCP 服务器(推荐使用仓库中描述的命令,例如通过 npx the-agents-mcp 启动)。服务器将自动选择 HTTP 端口或 STDIO 连接方式,具体取决于环境变量 MCP_HTTP_PORT 的配置。
- 使用 MCP 客户端连接并交互:LLM 客户端可通过 JSON-RPC 方式向 MCP 服务器请求资源、调用工具、获取 Prompts 等。
- 如需查看运行状态与观测 HUD,确保 Hub 服务端可访问并查看 viewer。
-
备注
- 本实现具备较完整的服务器端能力,覆盖资源、工具、Prompts 的注册与执行,并具备与 Hub 的双向交互能力,适合作为基于 MCP 的后端服务。