Terrakube

You can manage Terrakube workspaces, variables, modules, and organizations through a typed MCP server. This server provides a robust API surface, built with TypeScript, to automate and integrate Terrakube operations into your tooling and workflows.

How to use

To use the Terrakube MCP Server, run it locally and connect your MCP client or Claude Desktop integration to the provided command configuration. You can create, update, delete, and fetch workspaces, manage variables, handle modules, and administer organizations through the MCP endpoints. The server is designed to work with Terrakube’s API and reads configuration from environment variables for flexibility and security.

How to install

Prerequisites you should have before installation: Node.js and npm (or your preferred Node.js package manager). Ensure you have network access to the Terrakube API endpoint you plan to use.

# Install the Terrakube MCP Server via Smithery
npx -y @smithery/cli install @AzBuilder/mcp-server-terrakube --client claude

# Development setup (from source, if you want to run locally)
git clone https://github.com/azbuilder/terrakube-mcp-server.git
cd terrakube-mcp-server
npm install
npm run build

Additional sections

Environment configuration is handled through a .env file in the server’s root. You must provide the Terrakube API URL and a personal access token to authenticate with Terrakube.

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

Usage with Claude Desktop

To integrate the Terrakube MCP Server with Claude Desktop, configure the MCP server in your claude_desktop_config.json with the stdio command details and environment variables.

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

Available tools

createWorkspace

Create a new workspace within an organization with optional description and VCS integration details.

updateWorkspace

Update the properties of an existing workspace, including its description and VCS settings.

deleteWorkspace

Remove a workspace from an organization.

getWorkspace

Retrieve detailed information about a specific workspace.

listWorkspaces

List all workspaces within an organization.

createVariable

Create a new variable in a workspace with optional description, category, and sensitivity metadata.

updateVariable

Update an existing variable's value and metadata in a workspace.

deleteVariable

Delete a variable from a workspace.

getVariable

Fetch details for a specific variable in a workspace.

listVariables

List all variables in a workspace.

createModule

Create a new module under an organization with a provider and optional description.

updateModule

Update an existing module's description or provider information.

deleteModule

Delete a module from an organization.

getModule

Get details of a specific module by name and provider.

listModules

List all modules within an organization.

createOrganization

Create a new organization with an optional description.

updateOrganization

Update an organization’s description.

deleteOrganization

Delete an organization.

getOrganization

Get details of a specific organization.

listOrganizations

List all organizations.