OGrid MCP 服务器

关键词

文档检索IDE 集成桥接测试JSON-RPC文档资源

使用说明

  • 项目简介

    • 该库实现了一个独立的 MCP 服务器，用来把 OGrid 的资源（如文档页面）、工具（搜索文档、获取代码示例等）和提示/模板以 JSON-RPC 的形式暴露给 LLM 客户端。还内置了一个可选的 Live 测试桥接服务，方便在本地开发环境中让 IDE/编辑器与正在运行的 OGrid 实例交互。

  • 主要功能点

    • 文档资源与查询
      • 提供 docs 索引加载、按类别检索、按路径获取文档、获取代码示例等工具。
    • 工具集
      • search_docs、list_docs、get_docs、get_code_example、detect_version 等工具，帮助 LLM 客户端快速检索和呈现文档内容与代码示例。
    • Prompt 与模板
      • 内置提示模板与迁移向导等内容，支持对 LLM 的对话进行引导。
    • 桥接测试（Bridge）
      • 提供桥接测试客户端，支持实时读取运行中的 OGrid 状态、发送命令等，用于 IDE 的交互式开发与测试。
    • 资源模板
      • 以 ogrid://docs/Path 的形式暴露文档页面，便于在编辑器中直接跳转。
    • JSON-RPC 通信
      • MCP 服务器与客户端通过标准 JSON-RPC 进行请求与响应，服务器处理资源、工具、提示等请求，并返回结构化的 JSON-RPC 响应或通知。

  • 安装步骤

    • 准备环境
      • Node.js 版本 18 及以上
    • 安装与构建
      • 安装仓库依赖并构建（本仓库使用 monorepo/Turborepo 形式，通常在根目录执行安装并构建所有包）
    • 运行 MCP 服务器
      • 直接使用 npx 命令启动 MCP 服务器（示例：npx @alaarab/ogrid-mcp），也可添加 --bridge 启用桥接测试
    • 连接编辑器/IDE
      • 编辑器侧通过 MCP 配置连接到服务器，例如在 mcpServers 中配置 ogrid，命令和参数参照官方示例（下文的服务器配置部分给出可读格式）

  • 服务器配置（JSON 形式，供 MCP 客户端参考） { "server": { "name": "ogrid-docs", "command": "npx", "args": ["-y", "@alaarab/ogrid-mcp"] } , "bridge": { "port": 7890, "enabled": true }, "docsPath": "<可选：文档根目录路径，用于加载 docs 索引>" }

    说明：

    • name: MCP 服务器实例的名称，便于在编辑器中标识
    • command/args: 启动 MCP 服务器的命令及参数，默认使用 npx @alaarab/ogrid-mcp
    • bridge: 是否开启桥接测试，若开启则本地/dev 流程中可通过桥接连接运行中的 OGrid 实例
    • docsPath: 指向 docs 的根目录，若放在默认位置，可以不配置
    • MCP 客户端通常不需要额外的代码，直接读取上面的配置信息即可与服务器建立连接

  • 基本使用方法

    1. 启动 MCP 服务器
      • 在命令行执行：npx @alaarab/ogrid-mcp 或带 --bridge 的 npx @alaarab/ogrid-mcp --bridge
    2. 连接编辑器
      • 在编辑器的 MCP 配置中添加一个服务器条目，名称如 ogr id，命令为 npx， Args 为 ["-y", "@alaarab/ogrid-mcp"]，确保编辑器可连接到 MCP 服务器并读取文档、执行工具等
    3. 使用 MCP 功能
      • 通过工具调用（如 search_docs、get_docs 等）获取文档、代码示例和迁移指南
      • 使用资源路径（ogrid://docs/...）导航文档
      • 如需现场测试，可启用桥接，在编辑器中与正在运行的 OGrid 实例进行交互与观察
    4. 服务器与桥接的配合
      • 桥接模式用于开发阶段的实时调试与交互，默认端口通常设为 7890，开发者可自行通过环境变量修改端口
    5. 基本注意
      • MCP 服务端负责会话管理、能力声明和资源/工具/提示的渲染，客户端仅消费服务器提供的接口
      • 文档、示例、版本探测等功能均在 docs 索引与工具实现层实现，服务端对不同框架/语言的代码块进行检测和格式化，确保跨框架的一致性

  • 关键词 文档检索, IDE 集成, 桥接测试, JSON-RPC, 文档资源

  • 分类ID 6

服务器信息

访问项目