Skip to main content
Glama
terrakube-io

Terrakube MCP Server

by terrakube-io

get-variable

Retrieve detailed information about a specific variable in Terrakube by providing the organization, workspace, and variable IDs for efficient infrastructure management.

Instructions

Retrieves detailed information about a specific variable

Input Schema

TableJSON Schema
NameRequiredDescriptionDefault
organizationIdYesOrganization ID
variableIdYesVariable ID
workspaceIdYesWorkspace ID

Implementation Reference

  • The handler function for the 'get-variable' tool. It performs a GET request to the API to retrieve details of a specific variable identified by organizationId, workspaceId, and variableId, and returns the JSON data as text content.
    async ({ organizationId, workspaceId, variableId }) => {
      const response = await fetch(`${CONFIG.apiUrl}/organization/${organizationId}/workspace/${workspaceId}/variable/${variableId}`, {
        headers: {
          Authorization: `Bearer ${CONFIG.patToken}`,
          "Content-Type": "application/vnd.api+json"
        }
      });
    
      if (!response.ok) {
        throw new Error(`Failed to get variable: ${response.statusText}`);
      }
    
      const data = await response.json();
      return {
        content: [{
          type: "text",
          text: JSON.stringify(data, null, 2)
        }]
      };
    }
  • Input schema for the 'get-variable' tool, defining required string parameters: organizationId, workspaceId, and variableId using Zod.
    {
      organizationId: z.string().describe("Organization ID"),
      workspaceId: z.string().describe("Workspace ID"),
      variableId: z.string().describe("Variable ID")
    },
  • Registration of the 'get-variable' tool on the MCP server instance via server.tool(), specifying the tool name, description, input schema, and inline handler function.
    server.tool(
      "get-variable",
      "Retrieves detailed information about a specific variable",
      {
        organizationId: z.string().describe("Organization ID"),
        workspaceId: z.string().describe("Workspace ID"),
        variableId: z.string().describe("Variable ID")
      },
      async ({ organizationId, workspaceId, variableId }) => {
        const response = await fetch(`${CONFIG.apiUrl}/organization/${organizationId}/workspace/${workspaceId}/variable/${variableId}`, {
          headers: {
            Authorization: `Bearer ${CONFIG.patToken}`,
            "Content-Type": "application/vnd.api+json"
          }
        });
    
        if (!response.ok) {
          throw new Error(`Failed to get variable: ${response.statusText}`);
        }
    
        const data = await response.json();
        return {
          content: [{
            type: "text",
            text: JSON.stringify(data, null, 2)
          }]
        };
      }
    );
Behavior2/5

Does the description disclose side effects, auth requirements, rate limits, or destructive behavior?

No annotations are provided, so the description carries the full burden of behavioral disclosure. It states it 'retrieves' information, implying a read-only operation, but doesn't cover aspects like authentication needs, rate limits, error handling, or what 'detailed information' includes. This leaves significant gaps for a tool with no annotation coverage.

Agents need to know what a tool does to the world before calling it. Descriptions should go beyond structured annotations to explain consequences.

Conciseness5/5

Is the description appropriately sized, front-loaded, and free of redundancy?

The description is a single, efficient sentence that directly states the tool's purpose without unnecessary words. It is front-loaded and wastes no space, making it highly concise and well-structured.

Shorter descriptions cost fewer tokens and are easier for agents to parse. Every sentence should earn its place.

Completeness2/5

Given the tool's complexity, does the description cover enough for an agent to succeed on first attempt?

Given no annotations and no output schema, the description is incomplete. It doesn't explain what 'detailed information' entails in the return value, nor does it address behavioral aspects like permissions or errors. For a read operation with three required parameters, more context is needed to guide effective use.

Complex tools with many parameters or behaviors need more documentation. Simple tools need less. This dimension scales expectations accordingly.

Parameters3/5

Does the description clarify parameter syntax, constraints, interactions, or defaults beyond what the schema provides?

Schema description coverage is 100%, with all parameters documented in the schema (organizationId, workspaceId, variableId). The description adds no additional meaning beyond implying these IDs are needed to specify the variable, which is already clear from the schema. Baseline 3 is appropriate as the schema handles parameter documentation adequately.

Input schemas describe structure but not intent. Descriptions should explain non-obvious parameter relationships and valid value ranges.

Purpose4/5

Does the description clearly state what the tool does and how it differs from similar tools?

The description clearly states the verb ('retrieves') and resource ('specific variable') with a qualifier ('detailed information'), making the purpose evident. However, it doesn't explicitly differentiate from sibling tools like 'get-module' or 'get-workspace', which follow a similar pattern, so it misses full sibling distinction.

Agents choose between tools based on descriptions. A clear purpose with a specific verb and resource helps agents select the right tool.

Usage Guidelines2/5

Does the description explain when to use this tool, when not to, or what alternatives exist?

No guidance is provided on when to use this tool versus alternatives. For example, it doesn't mention using 'list-variables' to find variable IDs first or clarify if this is for single-variable lookups versus bulk operations. The description lacks any context or exclusions.

Agents often have multiple tools that could apply. Explicit usage guidance like "use X instead of Y when Z" prevents misuse.

Install Server

Other Tools

Related Tools

Latest Blog Posts

MCP directory API

We provide all the information about MCP servers via our MCP API.

curl -X GET 'https://glama.ai/api/mcp/v1/servers/terrakube-io/mcp-server-terrakube'

If you have feedback or need assistance with the MCP directory API, please join our Discord server