项目简介
MCP-TEAMATE 是一个基于 Model Context Protocol (MCP) 协议构建的 AI Agent 团队协作服务器。它使用 Server-Sent Events (SSE) 实现实时通信,并提供文档管理、Agent 记忆管理等功能,旨在为 AI Agent 提供一个类似公司团队的协作环境。通过 MCP 协议,AI Agent 可以进行通信、共享知识和协同工作。
主要功能点
- 实时通信: 基于 SSE 的实时消息传递,确保 Agent 之间信息同步。
- 文档管理: 提供版本控制的文档存储,支持文档访问控制和多 Agent 共享。
- Agent 记忆管理: 为每个 Agent 提供独立的持久化记忆存储,支持跨会话记忆和记忆共享。
- 多 Agent 协作: 支持多 AI Agent 注册和协同工作,构建团队协作环境。
- 安全消息传递: 提供安全的消息传递机制,保障通信安全。
- 持久化存储: 使用 SQLite 数据库进行数据持久化存储。
安装步骤
-
克隆仓库
git clone https://github.com/aokihu/mcp-teamate.git cd mcp-teamate -
安装依赖
确保已安装 Bun (>= 1.0.0) 或 Node.js (>= 18.0.0) 以及 SQLite3。然后运行:
bun install -
启动开发服务器
bun run dev
服务器配置
MCP 服务器配置信息(JSON 格式,用于 MCP 客户端配置):
{ "mcpServers": { "Teamate": { "url": "http://localhost:3001/sse" // MCP-TEAMATE 服务器 SSE 连接地址,默认为 http://localhost:3001/sse } } }
配置说明:
- '"Teamate"': 服务器名称,可以自定义。
- '"url"': MCP-TEAMATE 服务器的 SSE 连接端点 URL。如果服务器运行在非本地环境或使用了不同的端口,请相应修改 'localhost' 和 '3001'。
环境变量配置 (可选):
可以通过环境变量配置服务器 Host 和 Port:
TEAMATE_SERVER_HOST=0.0.0.0 # 服务器监听地址,默认为 localhost TEAMATE_SERVER_PORT=8080 # 服务器端口,默认为 3001 bun run dev
基本使用方法
- Agent 注册 (CheckIn): Agent 通过调用 'CheckIn' 工具向服务器注册,声明自己的 'id', 'role' 和 'description'。
- Agent 间通信 (SendMessage, GetMessage, WaitMessage): Agent 可以使用 'SendMessage' 工具向其他 Agent 发送消息,使用 'GetMessage' 或 'WaitMessage' 工具接收消息。
- 文档管理 (AddDocument, GetDocument, UpdateDocument, DeleteDocument, GetAllDocuments): Agent 可以使用文档管理工具对文档进行增删改查操作,实现知识共享和文档协作。
- 记忆管理 (WriteMemory, ReadMemory): Agent 可以使用记忆管理工具读写自身记忆,实现 Agent 状态的持久化。
示例工具调用 (在 MCP 客户端中调用):
-
Agent CheckIn:
mcp_Teamate_CheckIn({ id: "agent1", role: "assistant", description: "AI 助手" }); -
发送消息:
mcp_Teamate_SendMessage({ sender: "agent1", receiver: "agent2", content: "你好,Agent2!" }); -
获取文档:
mcp_Teamate_get_document({ slug: "doc1" });
更多工具和 API 细节请参考仓库 'README.md' 文档。
信息
分类
生产力应用