FrontMCP 服务器端框架与插件集合

使用说明

  • 项目简介
    • FrontMCP 是一个面向后端的 MCP 服务器框架,核心职责是暴露标准化的资源、工具、提示等能力,供大语言模型客户端以 JSON-RPC 形式进行交互,并通过传输层实现 SSE/HTTP 等通道。
    • 通过装饰器和 DI(依赖注入)机制,开发者可以用 TypeScript 快速搭建 MCP 服务器,并通过插件拓展功能,例如仪表盘、缓存、记忆、审批等。
  • 主要功能点
    • 资源(Resource) 与数据访问能力:暴露只读数据和资源模板,便于 LLM 调用和调试。
    • 工具(Tool) 注册与执行:定义类型化的工具,LLM 客户端可通过 JSON-RPC 调用工具。
    • 提示模板(Prompts) 与代理(Agents) 支持:便于统一模板化交互。
    • 会话管理与认证:支持多种会话模式和认证方案,保障上下文服务的安全性。
    • 传输协议与即时通信:内置流式 HTTP、SSE、WebSocket 等传输路径,便于与客户端的对话上下文同步。
    • 插件生态:丰富的官方插件(dashboard、cache、remember、approval 等)帮助快速扩展服务器能力。
  • 安装步骤
    • 需要 Node.js 22 及以上版本(推荐 24)。
    • 使用官方 CLI 或包管理工具创建项目并安装依赖,例如:
      • 新建项目:npx frontmcp create my-app
      • 现有项目:安装依赖并初始化工作区
    • 按需添加插件,例如 dashboard、cache、remember、approval 等,并在服务器入口应用装饰器中配置应用信息、端口和应用组件。
  • 服务器配置(适用于 MCP 客户端的连接信息)
    • MCP 客户端连接服务器需要提供一个 JSON 配置,包含服务器名称、启动命令以及启动参数等信息,用于在客户端端进行发现和连接。
    • 根据仓库信息,示例配置如下(请将具体字段替换为实际部署时的值):
      • serverName: Demo
      • command: npx
      • args: [frontmcp, dev, --port, 3000]
    • 注释说明:
      • serverName 对应 MCP 服务器在客户端显示的名称,通常与应用信息中的 name 字段保持一致。
      • command/args 指定启动 MCP 服务器的命令及参数,客户端据此启动并连接到服务器的 MCP 转发/传输通道。
      • 服务器实际在运行后,客户端可通过 JSON-RPC 请求获取资源、执行工具、获取 Prompts 等能力。
  • 基本使用方法
    • 启动服务器后,确保端口暴露并可供客户端连接。
    • 在客户端使用 JSON-RPC 调用 MCP 服务,例如读取资源、调用工具、获取提示等,框架会统一返回标准的 JSON-RPC 响应或通知。
    • 如需扩展,可通过添加插件实现缓存、记忆、审批、仪表盘等能力,增强服务端生态。

服务器信息