项目简介
'mcp-http-agent-md' 是一个面向AI代理的最小化Model Context Protocol (MCP) HTTP服务器。它专注于为AI代理提供高效的上下文管理系统,支持长期项目的工作流。核心功能包括:通过 'AGENTS.md' 存储项目级知识和配置,通过 'progress.md' 跟踪结构化任务并支持版本历史(日志/回溯),提供临时“草稿板”以管理短期任务和子代理(Subagents)上下文,并支持多种外部AI模型作为子代理执行聚焦任务。服务器还内置了身份验证和项目共享功能,便于团队协作。
主要功能点
- 分层上下文管理:
- 项目知识: 使用 'AGENTS.md' 文件作为AI代理的指导和积累知识库,以及 'progress.md' 跟踪长期任务和进展。
- 临时任务: 提供“草稿板”功能,用于创建临时的、聚焦的小任务,拥有独立但可共享的内存空间,避免主代理的上下文过载。
- 版本控制和历史: 自动对项目关键修改(如 'AGENTS.md' 和结构化任务)进行版本备份,支持查看历史日志和回溯到任意版本。
- 结构化任务管理: 支持添加、更新、设置任务状态(待办、进行中、已完成、已归档),并支持任务的层级嵌套。
- 子代理 (Subagents) 协作: 可以在草稿板内启动独立的子代理,用于解决特定、高上下文需求的子任务。子代理支持多种AI模型(Gemini, OpenAI, Groq等)以及其他MCP服务器作为工具。
- 用户认证与项目共享: 提供API密钥进行用户认证,支持将项目共享给其他用户,设置读写权限,实现多用户协作。
- Web UI界面: 内置轻量级管理控制台,提供看板视图等功能,方便用户管理项目和任务。
安装步骤
该服务器支持在类Unix系统(包括macOS和Linux)上通过脚本自动安装,或使用Docker进行安装。
- 不使用Docker安装 (推荐):
在终端运行以下命令,将服务器安装到 '$HOME/.config/mcp-http-agent-md' 目录,并以默认用户启动。
curl -fsSL https://raw.githubusercontent.com/benhaotang/mcp-http-agent-md/main/install/install.sh | bash - 使用Docker安装:
在终端运行以下命令,数据将持久化在 '$HOME/.config/mcp-http-agent-md/data' 目录。
curl -fsSL https://raw.githubusercontent.com/benhaotang/mcp-http-agent-md/main/install/install-docker.sh | bash - 手动安装:
- 克隆仓库: 'git clone https://github.com/benhaotang/mcp-http-agent-md.git'
- 进入项目目录: 'cd mcp-http-agent-md'
- 安装依赖: 'pnpm install' (推荐使用 pnpm, 也可使用 npm)
- 运行 (开发模式): 'pnpm dev'
- 运行 (生产模式): 'pnpm start'
服务器配置 (供MCP客户端连接)
'mcp-http-agent-md' 作为一个HTTP服务器运行。因此,MCP客户端应通过其URL地址进行连接。以下是MCP客户端配置此服务器的示例信息:
{ "mcpServers": { "my-agent-server": { "url": "http://localhost:3000/mcp?apiKey=YOUR_USER_API_KEY", "short_descriptions": "AI代理上下文项目管理服务,提供任务和知识管理工具" } // 如果服务器部署在远程,例如 https://your-deployment.com // "my-agent-server-remote": { // "url": "https://your-deployment.com/mcp?apiKey=YOUR_USER_API_KEY", // "short_descriptions": "远程AI代理上下文和任务管理服务" // } } }
- 'my-agent-server': 这是你在MCP客户端中为该服务器定义的名称。
- 'url': MCP服务器的访问地址。
- 'http://localhost:3000/mcp': 这是服务器默认的本地地址和MCP端点路径。如果你部署在其他主机或端口,请相应修改。
- '?apiKey=YOUR_USER_API_KEY': 你需要替换 'YOUR_USER_API_KEY' 为通过 '/auth' 端点为用户创建的实际API密钥。
- 'short_descriptions': 对该MCP服务器功能的简短描述,帮助LLM客户端理解其用途。
基本使用方法
- 获取API密钥: 首次运行服务器后,你需要使用Admin API为你的用户创建一个API密钥。默认的Admin API端点是 'http://localhost:3000/auth',需要使用环境变量 'MAIN_API_KEY' 作为Bearer令牌进行授权。
例如,在终端中执行以下命令(请将 'YOUR_MAIN_API_KEY' 替换为你的实际主API密钥):
请妥善保管返回的 'apiKey' (即 'YOUR_USER_API_KEY')。curl -X POST http://localhost:3000/auth/users \ -H "Authorization: Bearer YOUR_MAIN_API_KEY" \ -H "Content-Type: application/json" \ -d '{"name":"my-agent-user"}' # 成功后,将返回类似 {"id":"...", "apiKey":"YOUR_USER_API_KEY", "name":"my-agent-user"} 的JSON。 - 通过MCP客户端连接: 在你的MCP客户端中配置上述 'mcpServers' JSON信息,并使用你在步骤1中获取的 'YOUR_USER_API_KEY' 连接到服务器。
- 使用工具: 连接成功后,你的MCP客户端即可调用服务器提供的工具来管理项目、读写 'AGENTS.md'、管理任务、初始化草稿板和启动子代理等。例如,列出可用工具的MCP JSON-RPC请求如下:
服务器将返回一个JSON-RPC响应,其中包含所有可用的工具及其描述和输入Schema。curl -X POST 'http://localhost:3000/mcp?apiKey=YOUR_USER_API_KEY' \ -H 'Content-Type: application/json' \ -d '{"jsonrpc":"2.0","id":"1","method":"tools/list"}' - 访问Web UI: 在浏览器中访问 'http://localhost:3000/ui' (默认地址) 即可看到一个轻量级的项目管理界面,方便进行项目、任务和草稿板的可视化管理。
信息
分类
AI与计算