Bucketeer MCP

🚀 Bucketeer MCP Server

這是一個適用於 Bucketeer（一個開源的特性開關管理平臺）的模型上下文協議（MCP）服務器，用於管理特性開關。

⚠️ 重要提示

這是一個測試版本，在正式發佈之前可能會引入重大變更。

✨ 主要特性

此 MCP 服務器提供了對 Bucketeer 特性開關進行基本 CRUD 操作的工具：

• listFeatureFlags - 列出所有特性開關，並支持過濾和分頁
• createFeatureFlag - 創建新的特性開關
• getFeatureFlag - 通過 ID 獲取特定的特性開關
• updateFeatureFlag - 更新現有的特性開關
• archiveFeatureFlag - 歸檔特性開關（使其失效）

📦 安裝指南

前提條件

• Node.js 18 或更高版本
• 具有 API 訪問權限的 Bucketeer 實例
• 具有適當權限（READ、WRITE 或 ADMIN）的 API 密鑰

安裝步驟

1. 克隆此倉庫

git clone https://github.com/yourusername/bucketeer-mcp.git
cd bucketeer-mcp

2. 安裝依賴

npm install

3. 構建項目

npm run build

💻 使用示例

啟動服務器

啟動 MCP 服務器

npm start

開發時使用自動重載

npm run dev

MCP 客戶端配置

要在 MCP 客戶端中使用此服務器，請將其添加到 MCP 客戶端配置中

{
  "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"
      }
    }
  }
}

可用工具

listFeatureFlags

列出指定環境中的所有特性開關。

參數：

• environmentId（可選） - 環境 ID（若未提供則使用默認值）
• pageSize（可選） - 每頁的項目數（1 - 100，默認值：20）
• cursor（可選） - 下一頁的分頁遊標
• tags（可選） - 按標籤過濾
• orderBy（可選） - 排序字段（CREATED_AT、UPDATED_AT、NAME）
• 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（必需） - 要檢索的特性開關的 ID
• environmentId（可選） - 環境 ID（若未提供則使用默認值）
• featureVersion（可選） - 要檢索的特性的特定版本

updateFeatureFlag

更新現有的特性開關。

參數：

• id（必需） - 要更新的特性開關的 ID
• comment（必需） - 更新註釋（用於審計跟蹤）
• environmentId（可選） - 環境 ID（若未提供則使用默認值）
• name（可選） - 特性開關的新名稱
• description（可選） - 新描述
• tags（可選） - 新標籤
• enabled（可選） - 啟用或禁用特性開關
• archived（可選） - 歸檔或取消歸檔特性開關

注意：

• 此工具需要註釋以用於審計跟蹤
• 它不支持更新變體。若要修改變體，需要歸檔當前開關並創建一個新的。

archiveFeatureFlag

歸檔特性開關（使其失效）。歸檔的開關將為所有用戶返回代碼中定義的默認值。

參數：

• id（必需） - 要歸檔的特性開關的 ID
• environmentId（可選） - 環境 ID（若未提供則使用默認值）
• comment（必需） - 歸檔操作的註釋（用於審計跟蹤）

注意：此操作是歸檔開關，而非永久刪除。如有需要，稍後可以取消歸檔。

🔧 技術細節

代碼檢查

運行代碼檢查工具

npm run lint

代碼構建

構建 TypeScript 代碼

npm run build

🤝 貢獻代碼

我們非常歡迎您為 Bucketeer 做出貢獻，幫助改進它！任何人都可以使用並從中受益！

請遵循我們的貢獻指南 點擊此處。

📄 許可證

本項目採用 Apache License 2.0 許可協議，請參閱 LICENSE。