agenr MCP 服务端

使用说明(Markdown 格式)

  • 项目简介

    • agenr 是一个面向 LLM 客户端的后端系统,核心目标是提供统一的上下文服务:管理资源、注册并执行工具、以及定义与渲染 Prompt 模板。它通过 MCP(模型上下文协议)以标准化的 JSON-RPC 方式与客户端通信,支持多种传输通道,便于不同环境下的集成。
  • 主要功能点

    • 资源管理(Resources):以标准接口托管、读取和查询与上下文相关的本地数据与知识资源。
    • 工具注册与执行(Tools):注册外部功能,支持 LLM 通过工具调用执行外部操作。
    • Prompt 模板(Prompts):定义和渲染不同交互场景的提示模板,便于灵活的对话模式与上下文注入。
    • 会话与能力声明:服务器端负责会话状态、能力描述,以及对不同客户端能力的声明与管理。
    • 多传输协议支持:默认 StdIO 传输,理论上可扩展到 SSE、WebSocket 等,方便嵌入在各种应用场景中。
    • JSON-RPC 交互:遵循 MCP 的 JSON-RPC 风格请求/响应格式,统一的调用、查询和通知机制。
  • 安装步骤

    • 依赖 Node.js 20+ 环境,使用项目的包管理工具安装所需依赖,然后编译/构建。
    • 进入仓库根目录,安装依赖并编译源码(一般为 pnpm install,后续的构建步骤按项目脚本执行)。
    • 确认已安装的 Node.js 版本与项目要求一致。
  • 服务器配置(MCP 客户端需要的最小连接信息)

    • server 名称:agenr-mcp
    • 启动命令:agenr mcp
    • 参数(如有):无特殊附加参数默认为 stdio 传输;若使用其他传输,请在配置中指定对应选项
    • 说明:MCP 客户端需要的连接信息包括服务器启动命令与参数,以便通过标准输入输出或其他传输通道与 MCP 服务器建立连接。以下为描述性配置,用于理解客户端应提供的连接信息:
    • 服务器配置(JSON 形式描述,供 MCP 客户端使用):
      • server: "agenr-mcp"
      • command: "agenr"
      • args: ["mcp"] 注:该配置用于 MCP 客户端在启动时知道如何启动和连接到 MCP 服务器。客户端本身通常不需要实现服务器端逻辑,只需要知道如何启动和连接。
  • 基本使用方法

    • 启动服务器:在支持 MCP 的环境下执行 agenr mcp,服务器将以默认的 STDIO 传输启动,等待来自客户端的 JSON-RPC 请求。
    • 客户端交互:客户端通过 MCP 的标准 JSON-RPC 协议向服务器发起请求,例如读取资源、调用工具、获取或渲染 Prompts 等。服务器按请求返回 JSON-RPC 响应或发送通知。
    • 会话与安全:服务器端负责会话管理和能力声明,确保上下文信息和工具调用的安全可控。
  • 运行与部署注意

    • 根据项目实际实现,可能需要对接具体的 Embedding、VectorStore、数据库等组件;确保服务器的依赖与数据存储能在目标环境中正确初始化。
    • 如果需要通过 SSE/WebSocket 之类的传输方式对接客户端,请按项目文档配置传输层组件。
  • 额外信息

    • 本实现的目标是为 LLM 客户端提供一个统一的 MCP 服务端,帮助 LLM 更高效地获取上下文、调用外部工具、以及渲染可定制的 Prompt 模板,从而实现稳定、扩展性强的对话上下文服务。

服务器信息