MCP 服务器

Terrakube MCP Server

一个模型上下文协议服务器，它能够通过自然语言管理 Terrakube 基础设施，处理工作区管理、变量、模块和组织操作。

Tools

list-variables

Lists all variables in the specified workspace

list-organizations

Lists all organizations accessible to the current user

get-organization

Retrieves detailed information about a specific organization by its ID

create-organization

Creates a new organization with the specified name and optional description

edit-organization

Updates an existing organization's details

list-workspaces

Lists all workspaces in the specified organization

get-workspace

Retrieves detailed information about a specific workspace

create-workspace

Creates a new workspace in the specified organization

edit-workspace

Updates an existing workspace's details

list-modules

Lists all modules in the specified organization

get-module

Retrieves detailed information about a specific module

create-module

Creates a new module in the specified organization

edit-module

Updates an existing module's details

get-variable

Retrieves detailed information about a specific variable

create-variable

Creates a new variable in the specified workspace

edit-variable

Updates an existing variable's details

README

Terrakube MCP 服务器

<br/> 用于 Terrakube 操作的模型上下文协议 (MCP) 服务器，支持工作区管理、变量处理、模块操作和组织管理。

功能

全面的 API 集成: 与 Terrakube 的 API 完全集成，实现无缝操作
类型安全: 使用 TypeScript 构建，增强类型安全性和开发者体验
错误处理: 强大的错误处理，提供清晰的错误消息
环境配置: 通过环境变量进行灵活配置
模块化设计: 组织化的代码结构，易于维护和扩展

工具

工作区

`createWorkspace`

在 Terrakube 中创建一个新的工作区。

输入:
- name (string): 工作区名称
- organization (string): 组织名称
- description (optional string): 工作区描述
- vcsProviderId (optional string): VCS 提供商 ID
- vcsRepository (optional string): VCS 仓库名称
- vcsBranch (optional string): VCS 分支名称
返回: 创建的工作区详细信息

`updateWorkspace`

更新现有工作区。

输入:
- name (string): 工作区名称
- organization (string): 组织名称
- description (optional string): 新的工作区描述
- vcsProviderId (optional string): 新的 VCS 提供商 ID
- vcsRepository (optional string): 新的 VCS 仓库名称
- vcsBranch (optional string): 新的 VCS 分支名称
返回: 更新的工作区详细信息

`deleteWorkspace`

删除一个工作区。

输入:
- name (string): 工作区名称
- organization (string): 组织名称
返回: 成功状态

`getWorkspace`

获取特定工作区的详细信息。

输入:
- name (string): 工作区名称
- organization (string): 组织名称
返回: 工作区详细信息

`listWorkspaces`

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

输入:
- organization (string): 组织名称
返回: 工作区详细信息数组

变量

`createVariable`

在工作区中创建一个新变量。

输入:
- name (string): 变量名称
- organization (string): 组织名称
- workspace (string): 工作区名称
- value (string): 变量值
- description (optional string): 变量描述
- category (optional string): 变量类别
- hcl (optional boolean): 变量是否为 HCL
- sensitive (optional boolean): 变量是否敏感
返回: 创建的变量详细信息

`updateVariable`

更新现有变量。

输入:
- name (string): 变量名称
- organization (string): 组织名称
- workspace (string): 工作区名称
- value (string): 新的变量值
- description (optional string): 新的变量描述
- category (optional string): 新的变量类别
- hcl (optional boolean): 变量是否为 HCL
- sensitive (optional boolean): 变量是否敏感
返回: 更新的变量详细信息

`deleteVariable`

删除一个变量。

输入:
- name (string): 变量名称
- organization (string): 组织名称
- workspace (string): 工作区名称
返回: 成功状态

`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

开发

克隆仓库:

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

安装依赖:
```
npm install
```
构建项目:
```
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>"
      }
    }
  }
}