Civo MCP

🚀 Civo MCP Server

Civo MCP Server是一個與 Civo雲平臺 API集成的MCP服務器實現，具備管理雲實例、網絡和Kubernetes集群的能力。

🚀 快速開始

要求

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

# 對於 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 文件。

🔍 演示

或者，你也可以通過 這個公開的 Amp 線程 查看每個步驟的詳細信息。