README
🚀 ConfigCat MCP 服务器
ConfigCat 的模型上下文协议(MCP)服务器提供对 ConfigCat 公共管理 API 的访问,用于进行功能开关和配置管理。它还能让你的代码编辑器理解你的功能开关,将合适的 ConfigCat SDK 集成到你的项目中,甚至可以直接在你的代码库中创建新的功能开关。
✨ 主要特性
- 工具集:
- 具备用于 ConfigCat 公共管理 API 操作的全套工具。你可以在 ConfigCat 中创建、读取、更新和删除任何实体,如功能开关、配置、环境或产品。
- 获取全面的 SDK 文档和代码示例,以便在你的项目中无缝实现功能开关。
📦 安装指南
你可以使用以下环境变量来配置 MCP 服务器。
| 环境变量 | 是否必需 | 默认值 | 描述 | | -------------------- | -------- | ------- | ----------- | | CONFIGCAT_API_USER | ☑ | | ConfigCat 管理 API 基本认证用户名。 | | CONFIGCAT_API_PASS | ☑ | | ConfigCat 管理 API 基本认证密码。 | | CONFIGCAT_BASE_URL | | https://api.configcat.com | ConfigCat 管理 API 主机。 |
以下说明展示了如何将客户端连接到 MCP 服务器。
Cursor
- 打开
偏好设置->Cursor 设置->MCP 与集成 - 点击
添加自定义 MCP - 为 ConfigCat MCP 服务器添加以下服务器定义:
{
"mcpServers": {
"ConfigCat": {
"command": "npx",
"args": ["-y", "@configcat/mcp-server"],
"env": {
"CONFIGCAT_API_USER": "YOUR_API_USER",
"CONFIGCAT_API_PASS": "YOUR_API_PASSWORD"
}
}
}
}
- 保存设置。
Visual Studio Code
- 在你的项目根目录下创建一个
.vscode/mcp.json文件,内容如下:
{
"servers": {
"ConfigCat": {
"command": "npx",
"args": ["-y", "@configcat/mcp-server"],
"env": {
"CONFIGCAT_API_USER": "YOUR_API_USER",
"CONFIGCAT_API_PASS": "YOUR_API_PASSWORD"
}
}
}
}
- 保存设置文件。此时 MCP 服务器应该可以在 VS Code 中使用了。
Claude Desktop
- 打开 设置 → 开发者
- 点击 编辑配置
- 打开
claude_desktop_config.json - 为 ConfigCat MCP 服务器添加以下服务器定义:
{
"mcpServers": {
"ConfigCat": {
"command": "npx",
"args": ["-y", "@configcat/mcp-server"],
"env": {
"CONFIGCAT_API_USER": "YOUR_API_USER",
"CONFIGCAT_API_PASS": "YOUR_API_PASSWORD"
}
}
}
}
- 保存并重启 Claude。
📚 详细文档
可用工具
成员管理
- 组织:
list-organizations- 列出所有组织
- 成员:
list-organization-members- 列出组织成员list-pending-invitations- 列出待处理的邀请list-pending-invitations-org- 列出组织待处理的邀请list-product-members- 列出产品成员invite-member- 邀请新成员update-member-permissions- 更新成员的权限delete-organization-member- 移除组织成员delete-product-member- 移除产品成员delete-invitation- 取消邀请
- 权限组:
list-permission-groups- 列出权限组create-permission-group- 创建新的权限组get-permission-group- 获取权限组详情update-permission-group- 更新权限组delete-permission-group- 删除权限组
常规操作
- 产品:
list-products- 列出所有产品get-product- 获取特定产品的详情update-product- 更新现有产品delete-product- 删除产品get-product-preferences- 获取产品偏好设置update-product-preferences- 更新产品偏好设置create-product- 创建新产品
- 配置:
list-configs- 列出产品的配置create-config- 创建新配置get-config- 获取特定配置的详情update-config- 更新现有配置delete-config- 删除配置
- 环境:
list-environments- 列出产品的环境create-environment- 创建新环境get-environment- 获取特定环境的详情update-environment- 更新现有环境delete-environment- 删除环境
- 分段:
list-segments- 列出用户分段create-segment- 创建新分段get-segment- 获取特定分段的详情update-segment- 更新现有分段delete-segment- 删除分段
- SDK 密钥:
get-sdk-keys- 获取配置/环境的 SDK 密钥
- Webhook:
list-webhooks- 列出 Webhookget-webhook- 获取 Webhook 详情replace-webhook- 替换 Webhook 配置update-webhook- 更新现有 Webhookdelete-webhook- 删除 Webhookget-webhook-signing-keys- 列出 Webhook 签名密钥create-webhook- 创建新的 Webhook
- 集成:
list-integrations- 列出集成create-integration- 创建新的集成get-integration- 获取集成详情update-integration- 更新现有集成delete-integration- 删除集成
- 代码引用:
get-code-references- 获取代码引用
诊断
- 审计日志:
list-auditlogs- 获取产品审计日志list-organization-auditlogs- 获取组织审计日志
- 僵尸(陈旧)标志:
list-staleflags- 获取陈旧功能开关报告
功能开关元数据
- 功能开关与设置:
list-settings- 列出配置的功能开关create-setting- 创建新的功能开关get-setting- 获取特定功能开关的详情replace-setting- 替换功能开关配置update-setting- 更新现有功能开关delete-setting- 删除功能开关
- 标签:
list-tags- 列出产品的标签create-tag- 创建新标签list-settings-by-tag- 按标签获取功能开关get-tag- 获取特定标签的详情update-tag- 更新现有标签delete-tag- 删除标签
功能开关与设置值(v1 和 v2 API)
get-setting-value- 获取功能开关的值update-setting-value- 更新功能开关的值replace-setting-value- 替换功能开关的值get-setting-values- 获取多个设置的值post-setting-values- 更新多个设置的值- V2 变体:上述工具的
*-v2版本用于 Config V2
SDK 文档
update-sdk-documentation- 获取全面的 SDK 文档和代码示例,以便在你的项目中无缝实现功能开关。
API 速率限制
ConfigCat 公共 API 有速率限制。服务器将遵守这些限制,如果超出限制,将返回相应的错误消息。
安全注意事项
此服务器仅用于管理操作。请勿在生产应用程序中使用它来评估功能开关的值,而是使用 ConfigCat SDK 或 ConfigCat 代理。
📄 许可证
暂未提及相关许可证信息。
需要帮助?
贡献代码
欢迎贡献代码。更多信息请阅读 贡献指南。
Scan to join WeChat group