Bucketeer MCP

🚀 Bucketeer MCP Server

Bucketeer はオープンソースのフィーチャーフラグ管理プラットフォームで、このModel Context Protocol (MCP) サーバーは、Bucketeerにおけるフィーチャーフラグの管理を行います。

⚠️ 重要提示

これはベータ版です。正式リリース前に破壊的な変更が導入される可能性があります。

✨ 主な機能

この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ページあたりのアイテム数（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 を参照してください。