Terrakube MCP Server

Terrakube MCP 服务

用于 Terrakube 操作的模型上下文协议（MCP）服务，可管理工作区、处理变量、操作模块和管理组织。

功能

• 全面的 API 集成：全面集成 Terrakube 的 API，支持无缝操作
• 类型安全：使用 TypeScript 构建，增强类型安全性和开发者体验
• 错误处理：可靠的错误处理，并提供清晰的错误消息
• 环境配置：通过环境变量灵活配置
• 模块化设计：代码结构清晰，便于维护和扩展

工具

工作区

createWorkspace

在 Terrakube 中创建新的工作区。

• 输入：
  • name（字符串）：工作区名称
  • organization（字符串）：组织名称
  • description（可选字符串）：工作区描述
  • vcsProviderId（可选字符串）：VCS 提供商 ID
  • vcsRepository（可选字符串）：VCS 仓库名称
  • vcsBranch（可选字符串）：VCS 分支名称
• 返回：已创建的工作区详情

updateWorkspace

更新现有工作区。

• 输入：
  • name（字符串）：工作区名称
  • organization（字符串）：组织名称
  • description（可选字符串）：新的工作区描述
  • vcsProviderId（可选字符串）：新的 VCS 提供商 ID
  • vcsRepository（可选字符串）：新的 VCS 仓库名称
  • vcsBranch（可选字符串）：新的 VCS 分支名称
• 返回：已更新的工作区详情

deleteWorkspace

删除工作区。

• 输入：
  • name（字符串）：工作区名称
  • organization（字符串）：组织名称
• 返回：成功状态

getWorkspace

获取特定工作区的详情。

• 输入：
  • name（字符串）：工作区名称
  • organization（字符串）：组织名称
• 返回：工作区详情

listWorkspaces

列出组织中的所有工作区。

• 输入：
  • organization（字符串）：组织名称
• 返回：工作区详情数组

变量

createVariable

在工作区中创建新变量。

• 输入：
  • name（字符串）：变量名称
  • organization（字符串）：组织名称
  • workspace（字符串）：工作区名称
  • value（字符串）：变量值
  • description（可选字符串）：变量描述
  • category（可选字符串）：变量类别
  • hcl（可选布尔值）：变量是否为 HCL
  • sensitive（可选布尔值）：变量是否为敏感变量
• 返回：已创建的变量详情

updateVariable

更新现有变量。

• 输入：
  • name（字符串）：变量名称
  • organization（字符串）：组织名称
  • workspace（字符串）：工作区名称
  • value（字符串）：新的变量值
  • description（可选字符串）：新的变量描述
  • category（可选字符串）：新的变量类别
  • hcl（可选布尔值）：变量是否为 HCL
  • sensitive（可选布尔值）：变量是否为敏感变量
• 返回：已更新的变量详情

deleteVariable

删除变量。

• 输入：
  • name（字符串）：变量名称
  • organization（字符串）：组织名称
  • workspace（字符串）：工作区名称
• 返回：成功状态

getVariable

获取特定变量的详细信息。

• 输入：
  • name (string)：变量名称
  • organization (string)：组织名称
  • workspace (string)：工作区名称
• 返回：变量详细信息

listVariables

列出工作区中的所有变量。

• 输入：
  • organization (string)：组织名称
  • workspace (string)：工作区名称
• 返回：变量详细信息数组

模块

createModule

创建新模块。

• 输入：
  • name (string)：模块名称
  • organization (string)：组织名称
  • provider (string)：模块提供方
  • description (optional string)：模块描述
• 返回：已创建的模块详细信息

updateModule

更新现有模块。

• 输入：
  • name (string)：模块名称
  • organization (string)：组织名称
  • provider (string)：模块提供方
  • description (optional string)：新的模块描述
• 返回：已更新的模块详细信息

deleteModule

删除模块。

• 输入：
  • name (string)：模块名称
  • organization (string)：组织名称
  • provider (string)：模块提供方
• 返回：成功状态

getModule

获取特定模块的详细信息。

• 输入：
  • name (string)：模块名称
  • organization (string)：组织名称
  • provider (string)：模块提供方
• 返回：模块详细信息

listModules

列出组织中的所有模块。

• 输入：
  • organization (string)：组织名称
• 返回：模块详细信息数组

组织

createOrganization

创建新组织。

• 输入：
  • name (string)：组织名称
  • description (optional string)：组织描述
• 返回：已创建的组织详细信息

updateOrganization

更新现有组织。

• 输入：
  • name (string)：组织名称
  • description (optional string)：新的组织描述
• 返回：已更新的组织详细信息

deleteOrganization

删除组织。

• 输入：
  • name (string)：组织名称
• 返回：成功状态

getOrganization

获取特定组织的详细信息。

• 输入：
  • name (string)：组织名称
• 返回：组织详细信息

listOrganizations

列出所有组织。

• 返回：组织详细信息数组

设置

环境变量

在根目录中创建 .env 文件，并添加以下变量：

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

通过 Smithery 安装

要通过 Smithery 自动为 Claude Desktop 安装 Terrakube MCP Server：

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

开发

1. 克隆仓库：

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

2. 安装依赖项：

   npm install
   

3. 构建项目：

   npm run build
   

与 Claude Desktop 搭配使用

要将其与 Claude Desktop 搭配使用，请将以下内容添加到 claude_desktop_config.json：

{
  "mcpServers": {
    "terrakube": {
      "command": "npx",
      "args": [
        "-y",
        "@terrakube/mcp-server"
      ],
      "env": {
        "TERRAKUBE_API_URL": "<YOUR_API_URL>",
        "TERRAKUBE_PAT_TOKEN": "<YOUR_PAT_TOKEN>"
      }
    }
  }
}