Civo MCP

🚀 Civo MCP Server

Civo MCP Serverは、Civoクラウドプラットフォーム APIと統合されたMCPサーバーの実装です。クラウドインスタンス、ネットワーク、Kubernetesクラスターの管理機能を提供します。

🎥 デモ

また、この公開Ampスレッドを通じて各ステップの詳細を確認することもできます。

🚀 クイックスタート

必要条件

• Node.js 20以上
• Claude Desktop、VS Code、Cursor、またはその他のMCPクライアント
• APIキーを持つCivoアカウント

インストール

まず、クライアントでCivo MCPサーバーをインストールします。典型的な設定は次のようになります。

{
  "mcpServers": {
    "civo": {
      "command": "npx",
      "args": ["civo-mcp"],
      "env": {
        "CIVO_API_KEY": "YOUR_API_KEY_HERE"
      }
    }
  }
}

# For VS Code
code --add-mcp '{"name":"civo","command":"npx","args":["civo-mcp"],"env":{"CIVO_API_KEY":"YOUR_API_KEY_HERE"}}'

"amp.mcpServers": {
  "civo": {
      "command": "npx",
      "args": ["civo-mcp"],
      "env": {
        "CIVO_API_KEY": "YOUR_API_KEY_HERE"
      }
  }
}

claude mcp add civo npx civo-mcp

export CIVO_API_KEY="your_api_key_here"

{
  "mcpServers": {
    "civo": {
      "command": "npx",
      "args": ["civo-mcp"],
      "env": {
        "CIVO_API_KEY": "YOUR_API_KEY_HERE"
      }
    }
  }
}

{
  "mcpServers": {
    "civo": {
      "command": "npx",
      "args": ["civo-mcp"],
      "env": {
        "CIVO_API_KEY": "YOUR_API_KEY_HERE"
      }
    }
  }
}

{
  "mcpServers": {
    "civo": {
      "command": "npx",
      "args": ["civo-mcp"],
      "env": {
        "CIVO_API_KEY": "YOUR_API_KEY_HERE"
      }
    }
  }
}

{
  "mcpServers": {
    "civo": {
      "command": "npx",
      "args": ["civo-mcp"],
      "env": {
        "CIVO_API_KEY": "YOUR_API_KEY_HERE"
      }
    }
  }
}

✨ 主な機能

• インスタンス管理：クラウドインスタンスの作成、管理、サイズ変更、起動、停止、再起動、削除が可能です。
• ディスクイメージ操作：利用可能なディスクイメージの一覧表示と詳細取得ができます。
• ネットワーク管理：ネットワークの作成、名前変更、削除ができます。
• Kubernetesサポート：Kubernetesクラスターの作成、一覧表示、削除、および利用可能なバージョンの一覧表示ができます。
• 柔軟な設定：インスタンスサイズ、リージョン、その他のパラメータを設定できます。
• レート制限：APIの乱用を防止するための組み込みレート制限があります。

🛠️ ツール

インスタンス管理

• create_instance

  • Civo上に新しいクラウドインスタンスを作成します。
  • 入力:
    • hostname (文字列): 完全修飾ドメイン名
    • size (文字列): インスタンスサイズ (例: 'g2.small')
    • template_id (文字列): ディスクイメージID
    • count (数値、オプション): 作成するインスタンスの数 (デフォルト: 1)
    • region (文字列、オプション): リージョン識別子 (デフォルト: 'LON1')

• list_instances

  • Civo上のすべてのインスタンスを一覧表示します。
  • 入力:
    • region (文字列、オプション): リージョンでフィルタリング
    • page (数値、オプション): ページネーションのページ (デフォルト: 1)
    • per_page (数値、オプション): ページあたりの結果数 (デフォルト: 20)

• reboot_instance

  • 既存のインスタンスを再起動します。
  • 入力:
    • id (文字列): インスタンスID
    • region (文字列): リージョン識別子

• shutdown_instance

  • 既存のインスタンスを停止します。
  • 入力:
    • id (文字列): インスタンスID
    • region (文字列): リージョン識別子

• start_instance

  • 停止しているインスタンスを起動します。
  • 入力:
    • id (文字列): インスタンスID
    • region (文字列): リージョン識別子

• resize_instance

  • 既存のインスタンスのサイズを変更します。
  • 入力:
    • id (文字列): インスタンスID
    • size (文字列): 新しいインスタンスサイズ
    • region (文字列): リージョン識別子

• delete_instance

  • 既存のインスタンスを削除します。
  • 入力:
    • id (文字列): インスタンスID
    • region (文字列): リージョン識別子

ディスクイメージ

• list_disk_images

  • Civo上で利用可能なディスクイメージを一覧表示します。
  • 入力:
    • region (文字列、オプション): リージョン識別子

• get_disk_image

  • 特定のディスクイメージの詳細を取得します。
  • 入力:
    • id (文字列): ディスクイメージID
    • region (文字列、オプション): リージョン識別子

ネットワーク管理

• list_networks

  • すべての利用可能なネットワークを一覧表示します。
  • 入力: なし

• create_network

  • 新しいネットワークを作成します。
  • 入力:
    • label (文字列): ネットワークラベル
    • region (文字列、オプション): リージョン識別子

• rename_network

  • 既存のネットワークの名前を変更します。
  • 入力:
    • id (文字列): ネットワークID
    • label (文字列): 新しいネットワークラベル
    • region (文字列、オプション): リージョン識別子

• delete_network

  • 既存のネットワークを削除します。
  • 入力:
    • id (文字列): ネットワークID
    • region (文字列): リージョン識別子

Kubernetes管理

• list_kubernetes_clusters

  • すべてのKubernetesクラスターを一覧表示します。
  • 入力:
    • region (文字列、オプション): リージョンでフィルタリング
    • page (数値、オプション): ページネーションのページ
    • per_page (数値、オプション): ページあたりの結果数

• create_kubernetes_cluster

  • 新しいKubernetesクラスターを作成します。
  • 入力:
    • name (文字列): クラスター名
    • region (文字列): リージョン識別子
    • network_id (文字列): クラスターのネットワークID
    • nodes (数値): ワーカーノードの数
    • node_size (文字列): 各ノードのサイズ
    • kubernetes_version (文字列): Kubernetesバージョン

• delete_kubernetes_cluster

  • Kubernetesクラスターを削除します。
  • 入力:
    • id (文字列): クラスターID
    • region (文字列): リージョン識別子

• list_kubernetes_versions

  • 利用可能なKubernetesバージョンを一覧表示します。
  • 入力: なし

リソース情報

• list_sizes

  • すべての利用可能なインスタンスサイズを一覧表示します。
  • 入力: なし

• list_regions

  • すべての利用可能なリージョンを一覧表示します。
  • 入力: なし

⚙️ 設定

環境変数

• CIVO_API_KEY: あなたのCivo APIキー (必須)
• NODE_ENV: デバッグログを無効にするにはproductionに設定します (オプション)

APIキーの取得方法

1. Civoアカウントを持っていない場合は、Civoアカウントにサインアップします。
2. APIキーのドキュメントに従ってAPIキーを生成します。

🤝 コントリビューション

コントリビューションは大歓迎です！次の手順に従ってください。

1. リポジトリをフォークします。
2. 機能ブランチを作成します: git checkout -b feature-name
3. 変更を加え、テストを追加します。
4. テストスイートを実行します: npm run test:ci
5. プルリクエストを送信します。

開発環境のセットアップ

git clone https://github.com/tao12345666333/civo-mcp.git
cd civo-mcp
npm install
npm run build

テストの実行

# すべてのテストを実行
npm test

# ウォッチモードでテストを実行
npm run test:watch

# カバレッジレポートを生成
npm run test:coverage

📄 ライセンス

このMCPサーバーはMITライセンスの下でライセンスされています。詳細はLICENSEファイルを参照してください。