MCP Server Terrakube

🚀 Regional Terrakube MCP Server

Terrakube MCP Server is a tool designed for interacting with the Terrakube platform. It offers a variety of functions, including creating, updating, and deleting workspaces, variables, modules, and organizations.

✨ Features

• Type Safety: Ensures that all input and output data conform to the expected types.
• Environment Configuration: The server can be configured by setting environment variables as follows:

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

• Automated Installation: The installation can be automatically completed using the Smithery tool.

💻 Usage Examples

Workspace

Create a Workspace

createWorkspace(name: string, organization: string, provider: string, description?: string) ->_workspaceDetails

Update a Workspace

updateWorkspace(workspaceId: string, name: string, organization: string, provider: string, description?: string) ->updatedWorkspaceDetails

Delete a Workspace

deleteWorkspace(workspaceId: string)

Get Workspace Details

getWorkspace(workspaceId: string) ->workspaceDetails

List All Workspaces

listWorkspaces() ->ListOfWorkspacesResponse

Variable

Create a Variable

createVariable(name: string, organization: string, provider: string, description?: string) ->variableDetails

Update a Variable

updateVariable(variableId: string, name: string, organization: string, provider: string, description?: string) ->updatedVariableDetails

Delete a Variable

deleteVariable(variableId: string)

Get Variable Details

getVariable(variableId: string) ->variableDetails

List All Variables

listVariables() ->ListOfVariablesResponse

Module

Create a Module

createModule(name: string, organization: string, provider: string, description?: string) ->moduleDetails

Update a Module

updateModule(moduleId: string, name: string, organization: string, provider: string, description?: string) ->updatedModuleDetails

Delete a Module

deleteModule(moduleId: string)

Get Module Details

getModule(moduleId: string) ->moduleDetails

List All Modules

listModules() ->ListOfModulesResponse

Organization

Create an Organization

createOrganization(name: string, description?: string) ->organizationDetails

Update an Organization

updateOrganization(organizationId: string, name: string, description?: string) ->updatedOrganizationDetails

Delete an Organization

deleteOrganization(organizationId: string)

Get Organization Details

getOrganization(organizationId: string) ->organizationDetails

List All Organizations

listOrganizations() ->ListOfOrganizationsResponse

📦 Installation

Environment Variables

Create a .env file with the following content:

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

Installation with Smithery

Run the following command to install automatically:

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

🛠️ Development

1. Clone the repository:

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

2. Install dependencies:

   npm install
   

3. Build the project:

   npm run build
   

🤝 Integration with Claude Desktop

Add the following to 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>"
      }
    }
  }
}