使用说明内容(Markdown格式)
- 项目简介
- 这是一个以 Model Context Protocol (MCP) 标准为框架的服务器实现,旨在向大型语言模型客户端提供结构化的资源、工具和提示模板,帮助后端向对话代理提供可查询、可调用的上下文与功能。
- 主要功能点
- 提供工具:get_daily_briefing、get_facts、get_council_briefing、list_available_dates、search_knowledge 等 JSON-RPC 风格接口,供 LLM 客户端查询日常要闻、提取事实、获取理事会简报、列出可用日期、全局知识检索等。
- 资源暴露:facts/{date}、council/{date}、aggregated/{date} 等资源路径,客户端可按日期读取对应的 Facts、Council Briefing 以及聚合数据。
- 服务器能力与会话管理:实现了能力声明、会话管理等 MCP 服务端核心能力,确保多轮对话中的上下文获取与数据访问的一致性。
- 多传输能力设计:当前实现以 STDIO 传输(StdioServerTransport)为主,具备基础的 MCP 服务端能力;若后续扩展,可集成 SSE、WebSocket 等传输方式以支持流式通讯。
- 安全与容错:对数据读取做了路径校验、文件存在性判断与错误处理,返回清晰的错误信息与状态指示,帮助前端/客户端进行错误处理。
- 安装与运行步骤
- 安装与构建
- 进入 mcp-server 目录,执行 npm install 以安装依赖。
- 执行 npm run build 进行构建。
- 启动与运行
- 使用 Node.js 直接启动构建后的产物(dist/index.js),或按照工作流/部署环境配置为服务端应用。
- 与客户端对接
- MCP 客户端需要向服务器提供可连接的启动命令和参数(见下述“服务器配置”部分的示例),以建立 MCP 的连接并调用相应接口。
- 安装与构建
- 服务器配置(MCP 客户端需提供的启动配置示例)
下面给出一个示例说明,用于 MCP 客户端对接服务器的启动配置。请将示例中的路径与环境变量替换为实际部署环境中的值。
- server name: elizaos-knowledge
- command: node
- args: ["/path/to/knowledge/mcp-server/dist/index.js"]
- env: KNOWLEDGE_BASE_PATH: "/path/to/knowledge" 说明:该配置用于告知 MCP 客户端如何启动服务器进程,以及服务器在运行时应访问的知识库根目录。MCP 客户端本身不需要实现服务器逻辑,仅负责提供启动命令与参数让服务器进程正确启动并对外提供 API。
- 基本使用方法
- 客户端调用 MCP 服务端的 JSON-RPC 接口,查询日常简报、提取事实、获取理事会 briefing,或通过资源查询扩展上下文给 LLM 使用。
- 通过工具接口可以将聚合数据、事实与简报以结构化格式返回,便于在 LLM 对话中进行上下文注入与推理支撑。
- 对接时请确保服务器进程可以访问 KNOWLEDGE_BASE_PATH 指定的本地知识库数据目录,并且所需的读取权限已正确配置。
信息
分类
AI与计算