Gong MCP Server

使用说明(Markdown格式)

  • 项目简介

    • 该仓库实现一个 MCP 服务器,供 MCP 客户端(如 Claude 等)调用,用以访问 Gong API 数据、执行工具,以及返回格式化的输出。服务器通过 JSON-RPC 与客户端通信,提供资源/工具的注册与执行、会话管理等能力。
  • 主要功能点

    • 资源与工具管理:注册可用的资源与工具,响应客户端对资源读取以及工具执行的请求
    • 工具实现:提供诸如 list_calls、get_call_summary、get_call_transcript、list_users 等工具,支持输入校验并调用 Gong 客户端 API
    • 输出格式化:将 Gong API 的响应转换为简洁的 Markdown 表格/段落,便于 LLM 客户端在对话中展示
    • 会话与能力声明:通过 MCP 协议暴露服务器能力、支持多种传输(如 Stdio)并进行基础会话管理
    • 安全接入 Gong API:需通过环境变量提供 Gong 的 Access Key/Secret,服务器向 Gong API 进行请求
  • 安装步骤

    • 直接用 npx 启动(无需本地安装)
    • 也可以全局安装后启动
    • 也支持从源码构建后以 node 启动
    • 也可使用 Docker 运行并注入 Gong API 的凭证环境变量
    • 依赖: Node.js 18+ 或 Docker
  • 服务器配置(MCP 客户端的启动配置示例,非必须,客户端通常不需要了解内部实现) 说明:下面的配置用于 MCP 客户端在启动时知道要连接的 MCP 服务器的启动命令、参数及认证信息。具体字段含义如下:

    • serverName: MCP 服务器的名称标识
    • command: 启动命令
    • args: 启动参数
    • env: 启动时的环境变量(如 Gong API 的 Access Key/Secret)
    • 说明:MCP 客户端通常不需要该配置的代码实现细节,仅需知道如何启动服务器并传递凭证 服务器配置示例(JSON对象,不是代码块): { "serverName": "gongio-mcp", "command": "npx", "args": ["gongio-mcp"], "env": { "GONG_ACCESS_KEY": "<your-access-key>", "GONG_ACCESS_KEY_SECRET": "<your-secret-key>" }, "description": "启动 Gong 的 MCP 服务器,需提供 Gong 的访问密钥以访问 Gong API。" }
  • 基本使用方法

    • 启动方式一(推荐,最简):在有 Node.js 环境的终端执行 npx gongio-mcp,即可启动服务器,等待 MCP 客户端连接
    • 启动方式二:全局安装后执行 gongio-mcp
    • 启动方式三:从源码构建后运行 node dist/index.js(需先 npm install 与 npm run build)
    • 配置客户端:在 Claude、同类 MCP 客户端中配置一个 MCP 服务器条目,使用上述服务器的启动指令与凭证,即可开始交互
    • 使用场景示例:查询 Gong 调用、获取调用摘要、获取转录文本、列出工作区和用户等
  • 运行依赖与环境注意事项

    • 需要 Gong 的访问密钥(Access Key 与 Secret)作为环境变量传入
    • 服务器端默认通过标准输入输出传输(Stdio)进行 MCP 通信

服务器信息