Bucketeer MCP服务器
用于管理中的特征标志的模型上下文协议(MCP)服务器 巴克特,一个开源的功能标志管理平台。
\[!警告\] 这是一个测试版。在正式发布之前,可能会引入突破性的更改。
特性
此MCP服务器提供对Bucketeer功能标志进行基本CRUD操作的工具:
listFeatureFlags-列出所有带有过滤和分页的功能标志createFeatureFlag-创建新功能标志getFeatureFlag-按ID获取特定功能标志updateFeatureFlag-更新现有功能标志archiveFeatureFlag-将功能标志存档(使其处于非活动状态)
先决条件
- Node.js 18或更高版本
- 具有API访问权限的Bucketeer实例
- 具有适当权限(READ、WRITE或ADMIN)的API密钥
安装
使用npx(推荐)
使用Bucketeer MCP服务器的最简单方法是直接使用 npx -无需安装:
npx @bucketeer/mcp本地安装
- 克隆此存储库
git clone https://github.com/bucketeer-io/bucketeer-mcp.git
cd bucketeer-mcp- 安装依赖项
npm install- 构建项目
npm run build用法
运行服务器
使用npx(无需安装)
npx @bucketeer/mcp使用本地安装
启动MCP服务器
npm start用于自动重新加载的开发
npm run devMCP客户端配置
要将此服务器与MCP客户端一起使用,请将其添加到MCP客户端配置中。
使用npx(推荐)
{
"mcpServers": {
"bucketeer": {
"command": "npx",
"args": ["@bucketeer/mcp"],
"env": {
"BUCKETEER_HOST": "api.bucketeer.io",
"BUCKETEER_API_KEY": "your-api-key",
"BUCKETEER_ENVIRONMENT_ID": "your-environment-id"
}
}
}
}使用本地安装
{
"mcpServers": {
"bucketeer": {
"command": "node",
"args": ["/path/to/bucketeer-mcp/dist/index.js"],
"env": {
"BUCKETEER_HOST": "api.bucketeer.io",
"BUCKETEER_API_KEY": "your-api-key",
"BUCKETEER_ENVIRONMENT_ID": "your-environment-id"
}
}
}
}可用工具
list功能标签
列出指定环境中的所有功能标志。
参数:
environmentId(可选)-环境ID(如果未提供,则使用默认值)pageSize(可选)-每页项目数(1-100,默认值:20)cursor(可选)-下一页的分页光标tags(可选)-按标签筛选orderBy(可选)-排序依据字段(创建_AT、更新_AT、名称)orderDirection(可选)-订单方向(ASC、DESC)searchKeyword(可选)-搜索特征名称或ID的关键字maintainer(可选)-按维护者电子邮件筛选archived(可选)-按存档状态筛选
createFeatureFlag
创建新的特征标志。
参数:
id(必需)-唯一标识符(字母数字、连字符、下划线)name(必填)-人类可读名称description(可选)-功能标志的描述environmentId(可选)-环境ID(如果未提供,则使用默认值)variations(必填)-变量数组(至少2个)
- value (必填)-送达此变更时返回的值 - name (必填)-变更名称 - description (可选)-变化描述
tags(可选)-功能标志的标签defaultOnVariationIndex(必填)-标志打开时的变化指数(从0开始)defaultOffVariationIndex(必填)-标志关闭时的变化指数(从0开始)variationType(可选)-变量值的类型:STRING(默认)、BOOLEAN、NUMBER或JSON
getFeatureFlag
按ID获取特定功能标志。
参数:
id(必填)-要检索的特征标志的IDenvironmentId(可选)-环境ID(如果未提供,则使用默认值)featureVersion(可选)-要检索的功能的特定版本
updateFeatureFlag
更新现有功能标志。
参数:
id(必填)-要更新的功能标志的IDcomment(必填)-更新意见(审计跟踪所需)environmentId(可选)-环境ID(如果未提供,则使用默认值)name(可选)-功能标志的新名称description(可选)-新描述tags(可选)-新标签enabled(可选)-启用或禁用功能标志archived(可选)-存档或取消存档功能标志
注:
- 此工具需要注释以进行审计跟踪
- 它不支持更新变体。要修改变体,您需要存档当前标志并创建一个新的标志。
archiveFeatureFlag
将功能标志存档(使其处于非活动状态)。存档的标志将为所有用户返回代码中定义的默认值。
参数:
id(必填)-要存档的功能标志的IDenvironmentId(可选)-环境ID(如果未提供,则使用默认值)comment(必填)-对归档操作的评论(审计跟踪所需)
注意:此操作将存档标志,而不是永久删除它。如果需要,稍后可以取消存档标志。
发展
代码检查
运行门楣
npm run lint建筑
构建TypeScript代码
npm run build贡献
我们会❤️ 让您为Bucketeer做出贡献并帮助改进它!任何人都可以使用和享受它!
请遵循我们的捐款指南 这里.
许可证
Apache许可证2.0,请参阅 许可证.
