MCP Server Terrakube

🚀 地域kube MCP 服務器

Terrakube MCP Server 是一款用於與 Terrakube 平臺進行交互的工具。它具備創建、更新和刪除工作區、變量、模塊和組織等多種功能，能有效提升與平臺交互的效率。

🚀 快速開始

若要使用 Terrakube MCP Server，你需要先進行環境變量的配置，並完成工具的安裝。具體步驟如下：

環境變量配置

創建一個 .env 文件，內容如下：

TERRAKUBE_API_URL=<your-terrakube-api-url>
TERRAKUBE_PAT_TOKEN=<your-personal-access-token>

使用 Smithery 安裝

運行以下命令自動安裝：

npx -y @smithery/cli install @AzBuilder/mcp-server-terrakube --client claude

✨ 主要特性

• 類型安全：確保所有輸入和輸出的數據都符合預期類型，保證數據的準確性和穩定性。
• 環境配置：可通過設置環境變量來配置服務器，具體環境變量設置如下：

  TERRAKUBE_API_URL=<your-terrakube-api-url>
  TERRAKUBE_PAT_TOKEN=<your-personal-access-token>
  

• 自動化安裝：使用 Smithery 工具可自動完成安裝，節省安裝時間和精力。

💻 使用示例

工作區

基礎用法

以下是工作區的基本操作示例：

# 創建工作區
createWorkspace(name: string, organization: string, provider: string, description?: string) ->_workspaceDetails

# 獲取工作區詳情
getWorkspace(workspaceId: string) ->workspaceDetails

# 列出所有工作區
listWorkspaces() ->ListOfWorkspacesResponse

高級用法

# 更新工作區
updateWorkspace(workspaceId: string, name: string, organization: string, provider: string, description?: string) ->updatedWorkspaceDetails

# 刪除工作區
deleteWorkspace(workspaceId: string)

變量

基礎用法

# 創建變量
createVariable(name: string, organization: string, provider: string, description?: string) ->variableDetails

# 獲取變量詳情
getVariable(variableId: string) ->variableDetails

# 列出所有變量
listVariables() ->ListOfVariablesResponse

高級用法

# 更新變量
updateVariable(variableId: string, name: string, organization: string, provider: string, description?: string) ->updatedVariableDetails

# 刪除變量
deleteVariable(variableId: string)

模塊

基礎用法

# 創建模塊
createModule(name: string, organization: string, provider: string, description?: string) ->moduleDetails

# 獲取模塊詳情
getModule(moduleId: string) ->moduleDetails

# 列出所有模塊
listModules() ->ListOfModulesResponse

高級用法

# 更新模塊
updateModule(moduleId: string, name: string, organization: string, provider: string, description?: string) ->updatedModuleDetails

# 刪除模塊
deleteModule(moduleId: string)

組織

基礎用法

# 創建組織
createOrganization(name: string, description?: string) ->organizationDetails

# 獲取組織詳情
getOrganization(organizationId: string) ->organizationDetails

# 列出所有組織
listOrganizations() ->ListOfOrganizationsResponse

高級用法

# 更新組織
updateOrganization(organizationId: string, name: string, description?: string) ->updatedOrganizationDetails

# 刪除組織
deleteOrganization(organizationId: string)

📚 詳細文檔

與 Claude Desktop 配合使用

若要與 Claude Desktop 配合使用，需在 claude_desktop_config.json 中添加以下內容：

{
  "mcpServers": {
    "terrakube": {
      "command": "npx",
      "args": [
        "-y",
        "@terrakube/mcp-server"
      ],
      "env": {
        "TERRAKUBE_API_URL": "<your-terrakube-api-url>",
        "TERRAKUBE_PAT_TOKEN": "<your-personal-access-token>"
      }
    }
  }
}

🔧 技術細節

開發步驟

1. 克隆倉庫:

   git clone https://github.com/azbuilder/terrakube-mcp-server.git
   cd terrakube-mcp-server
   

2. 安裝依賴:

   npm install
   

3. 構建項目:

   npm run build