lude-mcp
使用说明内容(Markdown格式)
使用说明
项目简介
lude-mcp 是一个基于 MCP(Model Context Protocol)的自托管服务器实现。它通过标准的 JSON-RPC 交互在标准传输通道(stdio)上向 AI 客户端提供统一的上下文服务:管理内存资源、注册与执行工具、提供可自定义的提示模板,并可通过本地 HTTP 界面探索和调试存储的记忆。
主要功能点
- 内存资源管理:存储、检索、记忆图谱等功能,支持 episodic/semantic/procedural/self_model 四种内存类型及其衰减、嵌入与联结。
- 工具执行与管理:13 种工具分为存储、检索、图、分析、认知与实用工具,支持读取、写入、打包导入导出等操作。
- 提示模板与协议:提供内置的提示与 autonomous memory protocol(agent_memory_protocol),支持全球可用性与自动化执行。
- 自主内存协议:通过 agent_memory_protocol 提供生命周期无关的工作流程,自动在会话中触发 recalling、hydration、tagging、linking 等步骤。
- 本地内存浏览器界面:可选开启 http explorer,提供 memory 浏览、检索与统计等图形化展示,便于本地调试与演示。
- 自托管与云端两种模式均可使用(自托管模式需要 Supabase,云端模式需要 CORTEX API)。
- 与 Claude/Cursor 等 MCP 客户端的互操作:通过标准的 MCP JSON-RPC 调用实现工具与资源的访问。
安装步骤
- 克隆仓库并安装依赖
- git clone <仓库地址>
- 进入项目目录并执行 npm install
- 构建产出:npm run build
- 环境变量配置
- 将 .env.example 复制为 .env,并填写以下关键项(具体列在 README 中):
- 自托管模式所需:SUPABASE_URL、SUPABASE_KEY
- Embedding/Anthropic 配置:ANTHROPIC_API_KEY、EMBEDDING_PROVIDER 与相应的 API KEY 等
- 其他可选:MEMORY_TURN_THRESHOLD、MEMORY_IMPORTANCE_THRESHOLD、EXPLORER_PORT 等
- 将 .env.example 复制为 .env,并填写以下关键项(具体列在 README 中):
- 启动 MCP 服务器
- 读取 dist/index.js(或 tsx/其他运行方式下的打包入口)
- 运行命令示例(客户端一般通过配置指向该命令与参数以建立连接)
- 运行本地资源浏览器(可选)
- 设置 EXPLORER_PORT 以启用 http explorer,服务器将在本地 127.0.0.1 上提供 UI。
服务器配置(给 MCP 客户端的连接信息)
说明:MCP 客户端需要提供连接信息以通过标准输入输出(stdio)与 MCP 服务器建立通信。以下为示例结构,描述服务器名称、启动命令与参数;具体数值请按实际运行环境填写。
{ "server": { "name": "clude", "command": "node", "args": ["dist/index.js"] } // 备注:以上信息用于 MCP 客户端在本地启动并通过 stdio 与服务器通信 }
说明:该配置信息用于文档化说明,客户端在实现连接时会直接使用服务器名称与执行命令来启动 MCP 服务进程,并将 JSON-RPC 请求发送至其标准输出,接收响应于标准输入。
基本使用方法
- 启动后,服务器将监听 stdio 传输,客户端通过 MCP JSON-RPC 调用来:
- 列出可用工具、资源、提示(ListTools、ListResources、ListPrompts)
- 调用工具(如 store_memory、recall_memories、dream 等)完成内存管理与推理任务
- 读取资源(memory://stats、memory://recent/24h 等)
- 获取/渲染提示(memory_context、agent_memory_protocol 等)
- 如需本地调试与观测,可打开本地浏览器访问本地的 memory explorer(若启用 EXPLORE_PORT)。
- 部署完毕后即可将 MCP 客户端连接到该服务器,实现统一的上下文服务能力。