Terrakube

🚀 Terrakube MCP Server

Terrakube MCP Server is a Model Context Protocol (MCP) server integrated with the Terrakube platform. It offers a series of API interfaces for managing resources such as workspaces, variables, modules, and organizations.

🚀 Quick Start

Terrakube MCP Server is a Model Context Protocol (MCP) server designed for seamless integration with the Terrakube platform. It provides a comprehensive set of API interfaces to manage various resources effectively.

✨ Features

• Workspace Management: Create, update, delete, and retrieve workspaces.
• Variable Management: Manipulate variables associated with workspaces.
• Module Management: Handle the lifecycle of modules.
• Organization Management: Implement functions for creating, updating, and deleting organizations.
• Environment Configuration: Configure server runtime parameters by setting environment variables.

📦 Installation

Environment Variable Configuration

Create a .env file in the project root directory and add the following variables:

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

Installation via Smithery

Automatically install Terrakube MCP Server through Smithery:

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

Development Process

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 configuration to 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>"
      }
    }
  }
}

📚 Documentation

Workspace Management

Create Workspace

createWorkspace(name: string, organization: string, description?: string) => WorkspaceDetails;

Update Workspace

updateWorkspace(workspaceId: string, name: string, organization: string, description?: string) => UpdatedWorkspace;

Delete Workspace

deleteWorkspace(workspaceId: string) => boolean;

Get Workspace Details

getWorkspace(workspaceId: string) => WorkspaceDetails;

Variable Management

Create Variable

createVariable(workspaceId: string, key: string, value: string, description?: string) => Variable;

Update Variable

updateVariable(variableId: string, workspaceId: string, key: string, value: string, description?: string) => UpdatedVariable;

Module Management

Create Module

createModule(name: string, organization: string, provider: string, description?: string) => ModuleDetails;

Update Module

updateModule(moduleId: string, name: string, organization: string, provider: string, description?: string) => UpdatedModule;

Organization Management

Create Organization

createOrganization(name: string, description?: string) => OrganizationDetails;

Update Organization

updateOrganization(organizationId: string, name: string, description?: string) => UpdatedOrganization;

Project Badges

By following the steps above, you can easily configure and use Terrakube MCP Server and integrate it with Claude Desktop.