create-workspace
Generate a new workspace in a specified organization with defined Terraform version, name, and optional VCS settings using the Terrakube MCP Server.
Instructions
Creates a new workspace in the specified organization
Input Schema
TableJSON Schema
| Name | Required | Description | Default |
|---|---|---|---|
| description | No | Workspace description | |
| name | Yes | Workspace name | |
| organizationId | Yes | Organization ID | |
| terraformVersion | Yes | Terraform version | |
| vcsProvider | No | VCS provider (e.g., github, gitlab) | |
| vcsRepo | No | VCS repository URL |
Implementation Reference
- src/tools/workspaces.ts:74-106 (handler)The asynchronous handler function that implements the core logic of the 'create-workspace' tool. It sends a POST request to the Terrakube API endpoint to create a new workspace using the provided organizationId, name, description, terraformVersion, vcsProvider, and vcsRepo, then returns the JSON response.
async ({ organizationId, name, description, terraformVersion, vcsProvider, vcsRepo }) => { const response = await fetch(`${CONFIG.apiUrl}/organization/${organizationId}/workspace`, { method: "POST", headers: { Authorization: `Bearer ${CONFIG.patToken}`, "Content-Type": "application/vnd.api+json" }, body: JSON.stringify({ data: { type: "workspace", attributes: { name, description, terraformVersion, vcsProvider, vcsRepo } } }) }); if (!response.ok) { throw new Error(`Failed to create workspace: ${response.statusText}`); } const data = await response.json(); return { content: [{ type: "text", text: JSON.stringify(data, null, 2) }] }; } - src/tools/workspaces.ts:66-73 (schema)Zod input schema defining the parameters for the 'create-workspace' tool: organizationId (required), name (required), description (optional), terraformVersion (required), vcsProvider (optional), vcsRepo (optional).
{ organizationId: z.string().describe("Organization ID"), name: z.string().describe("Workspace name"), description: z.string().optional().describe("Workspace description"), terraformVersion: z.string().describe("Terraform version"), vcsProvider: z.string().optional().describe("VCS provider (e.g., github, gitlab)"), vcsRepo: z.string().optional().describe("VCS repository URL") }, - src/tools/workspaces.ts:63-107 (registration)The server.tool() registration call for the 'create-workspace' tool within the registerWorkspaceTools function, specifying name, description, input schema, and handler.
server.tool( "create-workspace", "Creates a new workspace in the specified organization", { organizationId: z.string().describe("Organization ID"), name: z.string().describe("Workspace name"), description: z.string().optional().describe("Workspace description"), terraformVersion: z.string().describe("Terraform version"), vcsProvider: z.string().optional().describe("VCS provider (e.g., github, gitlab)"), vcsRepo: z.string().optional().describe("VCS repository URL") }, async ({ organizationId, name, description, terraformVersion, vcsProvider, vcsRepo }) => { const response = await fetch(`${CONFIG.apiUrl}/organization/${organizationId}/workspace`, { method: "POST", headers: { Authorization: `Bearer ${CONFIG.patToken}`, "Content-Type": "application/vnd.api+json" }, body: JSON.stringify({ data: { type: "workspace", attributes: { name, description, terraformVersion, vcsProvider, vcsRepo } } }) }); if (!response.ok) { throw new Error(`Failed to create workspace: ${response.statusText}`); } const data = await response.json(); return { content: [{ type: "text", text: JSON.stringify(data, null, 2) }] }; } );