Remnant MCP 服务器
使用说明(Markdown 格式)
项目简介
- Remnant 脚手架内置一个 MCP 服务器实现,供 MCP 客户端(如 Claude Code)通过标准化的 JSON-RPC 调用获取并使用 Remnant 的资源、工具与提示模板。
主要功能点
- 通过 MCP JSON-RPC 2.0 入口暴露以下工具:
- memory_retrieve:基于向量检索返回相关记忆片段。
- memory_record:将新记忆记录到存储并建立索引。
- agent_run:以记忆上下文执行一个代理任务,返回流水线化结果。
- skill_execute:调用注册的技能。
- 提供 MCP 服务器初始化、工具调用、以及工具集合的查询与调用。
- 支持通过服务器端 SSE/HTTP 进行流式传输,满足 Claude Code 的 MCP 流式能力对接需求。
- 与 Remnant 的内存、工具、以及代理运行时解耦耦合,便于从 LLM 客户端向后端发起任务并得到结构化响应。
安装步骤
- 获取代码:克隆包含 MCP 服务的 Remnant 仓库。
- 安装依赖:在项目根目录执行安装命令安装依赖(例如 Python 3.11+、pip 依赖文件 requirements.txt)。
- 启动服务器:使用 FastAPI + Uvicorn 运行 API 服务,例如启动命令将暴露 /mcp 与 /mcp/stream 接口。
- 配置环境:根据需要提供 Redis、LLM 提供者密钥、以及必要的对外服务地址等环境变量。
服务器配置(面向 MCP 客户端,JSON 配置示例,含 server 名称、启动命令与参数) { "server_name": "remnant-mcp", "command": "uvicorn", "args": [ "api.main:app", "--host", "0.0.0.0", "--port", "8000", "--reload" ], "notes": "该配置用于 MCP 客户端在本机或容器化环境启动并连接 Remnant 的 MCP 服务端。实际参数可根据运行环境调整(如是否开启热重载、绑定端口等)。" }
基本使用方法
- MCP 连接与发现:在 MCP 客户端配置中将 Remnant MCP 服务器地址设置为服务器暴露的 /mcp 接口地址(如 http://localhost:8000/mcp),并指定传输协议为 http,或按需使用 SSE/WebSocket。
- 资源与工具:通过 MCP 客户端调用 memory_retrieve、memory_record、agent_run、skill_execute 等工具接口,Remnant 服务端将返回相应的 JSON-RPC 响应或流式数据。
- 会话与能力:Remnant 服务端在后端管理会话与能力声明,客户端可通过 initialize、tools/list、tools/call 等方法查询能力并触发工具执行。
- 安全与扩展性:MCP 服务端对工具执行设有策略、对请求进行上下文注入和安全检查,确保对外提供一个可扩展、可安全对接的上下文服务框架。
关键词 内存检索, 工具执行, JSON-RPC, 流式传输, Claude Code
分类ID 6