Planning Game XP MCP 服务器

关键词

模型上下文协议LLM 集成资源管理工具注册JSON-RPC

使用说明（Markdown 格式）

  • 项目简介

    • 该仓库实现了一个基于 MCP 的服务器后端，用于向 LLM 客户端提供计划游戏任务管理所需的上下文数据、可执行的工具、以及可渲染的提示模板。服务器通过 JSON-RPC 与客户端通信，负责资源的读取、工具调用、以及 Prompts 的渲染与管理，并与 Firebase 数据库进行交互。

  • 主要功能点

    • 资源管理：托管与读取如任务、卡片、项目等资源数据，供 LLM 进行查询和操作。
    • Tools 注册与执行：注册并执行外部工具，允许 LLM 调用外部功能实现自动化任务。
    • Prompt 定义与渲染：定义和渲染可定制的 Prompt 模板，支持不同的交互模式。
    • JSON-RPC 通信：以标准的 JSON-RPC 协议接收请求并返回响应或发送通知。
    • 会话与能力声明：会话管理、能力声明以及权限控制，确保安全、可扩展的上下文服务。
    • 多传输协议支持（理论/示例实现）：设计目标支持多种传输协议，便于与不同的 MCP 客户端进行集成。

  • 安装步骤

    • 克隆仓库并安装依赖：安装 Node.js 环境后，执行 npm install 以安装依赖。
    • 准备环境与凭证：按照仓库提供的 MCP 安装指南配置 Firebase 访问（需要 serviceAccountKey.json、Firebase 项目等信息）。
    • 启动 MCP 服务器：在包含 MCP 服务端入口的目录中运行对应的启动命令（通常为 node index.js 或 npm 脚本），服务器将监听并通过 MCP JSON-RPC 与客户端通信。
    • 客户端配置（MCP 客户端在使用时需要的最小信息）
      • MCP 客户端启动时需要提供服务器信息（如服务器名称、启动命令和参数等）以建立连接。以下为示例描述，实际使用请以生成的 JSON 配置为准：
        • serverName: planning-game
        • command: node
        • args: ["/path/to/mcp-servers/planning-game/index.js"]（实际路径请根据本地安装位置填写）
        • 说明：此处配置仅用于 MCP 客户端连接服务器，客户端无需暴露凭证信息，凭证通常在服务器端配置并由服务端使用。

  • 服务器配置（JSON 配置说明，非代码）

    • serverName：唯一标识 MCP 服务器的名称，例如 "planning-game"
    • command：启动服务器所使用的可执行命令，例如 "node"
    • args：启动命令的参数，包含入口脚本路径，例如 ["/path/to/mcp-servers/planning-game/index.js"]
    • 说明：MCP 客户端通过该 JSON 配置与服务器建立连接，读取可用的资源、工具和提示模板，并通过 JSON-RPC 请求服务器执行相应操作。

  • 基本使用方法

    • 启动并接入：确保 MCP 服务器已正确启动并可被客户端访问，客户端连接后即可通过 MCP 的工具和资源接口获取上下文信息。
    • 请求与响应：通过 JSON-RPC 调用获取资源、注册/执行工具、获取与渲染 Prompts 等，服务器返回标准化的 JSON-RPC 响应。
    • 安全与扩展：服务器负责会话管理与能力声明，支持针对不同 LLM 客户端的权限控制与扩展能力，以便在未来支持更多的数据源与工具。

  • 备注

    • 该仓库的 MCP 部分文档和实现均包含在测试与工具目录中，服务器端代码与客户端使用示例共同构成完整的 MCP 解决方案。实际部署时，请遵循仓库中的 MCP 安装指南和文档。

服务器信息

访问项目