ConfigCat MCP Server

使用说明(简要、易操作)

  • 项目简介
    • 本仓库实现一个 MCP 服务器端应用,能够向 LLM 客户端暴露 ConfigCat 的管理 API 相关的资源、工具和提示模板。通过 JSON-RPC 形式与客户端通信,允许客户端读取资源、调用工具、获取并渲染提示模板等功能。
  • 主要功能点
    • 工具注册与执行:将 ConfigCat 的公开管理 API 的操作封装为可调用的工具(如 list-organizations、list-products、list-tags、create-tag 等),供 LLM 调用并获取文本化的 API 响应。
    • HTTP 封装与鉴权:使用 Basic Auth 调用 ConfigCat Public Management API,支持自定义 base URL、用户名、密码等。
    • 文档工具:提供更新 SDK 文档的工具,将 ConfigCat 的 SDK 文档页内容作为回答的一部分返回给客户端。
    • MCP 服务器与传输:基于 Model Context Protocol 的服务器框架,使用 Stdio 传输等方式与 MCP 客户端通信。
    • 错误与认证容错:对无效参数、HTTP 认证失败等情况给出清晰的错误信息,便于调试。
  • 安装步骤
    • 该仓库包含可直接运行的服务器代码,依赖外部的 Model Context Protocol SDK。请确保在目标环境中已安装 Node.js 以及依赖项(通常通过 npm/yarn 安装包依赖)。
    • 运行方式示例(外部客户端常用的启动指令,实际使用请以客户端约定为准):
      • 使用 npm/npx 启动:npx -y @configcat/mcp-server
      • 或将本地构建后的入口执行文件作为服务启动命令
  • 服务器配置(MCP 客户端使用的启动配置示例,JSON 格式,含 server name、command、args 等) 服务器配置示例(JSON): { "servers": { "ConfigCat": { "command": "npx", "args": ["-y", "@configcat/mcp-server"], "env": { "CONFIGCAT_API_USER": "YOUR_API_USER", "CONFIGCAT_API_PASS": "YOUR_API_PASSWORD" } // 说明:CONFIGCAT_BASE_URL 默认为 https://api.configcat.com,可按需覆盖。 } } }
  • 基本使用方法
    • 启动服务器后,LLM 客户端通过配置的 MCP 服务器启动命令与参数即可建立连接。
    • 通过调用“工具”接口,LLM 可以执行 ConfigCat 的 API 操作,例如获取组织、产品、标签等信息,返回文本化的 API 响应。
    • 使用文档工具可获取 ConfigCat 的 SDK 文档页面内容,帮助生成代码示例或对接 SDK。
    • 如遇认证问题,确保环境变量 CONFIGCAT_API_USER 与 CONFIGCAT_API_PASS 设置正确,并且 ConfigCat 公共管理 API 的凭据有效。

服务器信息