使用说明(Markdown 格式)

  • 项目简介

    • 该仓库实现了一个 MCP 服务器,用于通过 JSON-RPC 与 LLM 客户端进行通信,暴露若干与 GitHub 工作流、部署及故障分析相关的工具,便于在大模型应用中进行自动化监控与判断。
  • 主要功能点

    • 提供 MCP 协议的核心能力:列出可用工具、按工具调度执行输入参数,并返回标准化的 ToolResult 结果。
    • 暴露的工具包含 gh_monitor_run、gh_monitor_pr_checks、gh_monitor_merge_queue、gh_get_deployment_urls、gh_get_failure_details,用于监控工作流、PR 检查、合并队列、部署 URL 提取以及失败详情提取。
    • 以 JSON-RPC 风格处理请求,统一错误输出,便于上游 LLM 客户端解析与处理。
    • 通过 stdio 传输,服务器端实现可直接在支持的运行环境中以管道方式与客户端通信。
  • 安装步骤

    • 在仓库中定位 MCP 服务器代码目录(gh-workflow-mcp-server)。
    • 安装依赖并构建/运行服务器:
      • 安装依赖
      • 构建并运行 MCP 服务器,使其通过 STDIO 接收请求
    • 如需对接特定客户端,请确保客户端遵循 MCP 的 JSON-RPC 规范,与服务器进行请求/响应交互。
  • 服务器配置(MCP 客户端启动配置示例,非客户端代码)

    • 服务器名称:gh-workflow-mcp-server
    • 启动命令(示例,实际部署可根据运行环境调整):
      • command: node
      • args: ["dist/index.js"](假设构建产物位于 dist/index.js,此处以文本形式描述,便于理解客户端需要的配置信息)
    • 说明:MCP 客户端需要的仅是启动服务器的命令与参数,用以启动与 MCP 服务器对话的进程。这部分信息仅用于描述客户端如何连接,不属于客户端代码。

    服务器配置信息(JSON,供 MCP 客户端参考): { "server": { "name": "gh-workflow-mcp-server", "command": "node", "args": ["dist/index.js"] }, "transport": "stdio", "description": "MCP 服务端,提供工作流监控、部署与失败分析工具" } 注释:以上配置用于描述启动服务器的命令、参数与通信传输方式,具体客户端实现无需执行服务器端代码,只需按 MCP 协议发送请求并解析响应。

  • 基本使用方法

    • 客户端通过 JSON-RPC 调用 MCP 服务,执行以下典型流程:
        1. 调用 ListTools 请求,获取可用工具的名称、输入规范、描述等。
        1. 按需调用 CallTool,提供所选工具的输入参数,获取工具执行结果(ToolResult)。
        1. 根据 ToolResult 的 content 字段解析文本输出,或根据 isError 标记处理错误。
    • 常见用法包括监控 GitHub 工作流 Run、PR Checks、Merge Queue,以及从运行日志中提取部署 URL、失败细节等。
    • 错误处理统一通过 MCP 的 ToolResult 结构返回,便于后续上游系统进行统一处理。

信息

分类

网页与API