Skip to main content
Glama
terrakube-io

Terrakube MCP Server

by terrakube-io

list-modules

Retrieve all modules within a specified organization using the Terrakube MCP Server for efficient infrastructure management and organization operations.

Instructions

Lists all modules in the specified organization

Input Schema

TableJSON Schema
NameRequiredDescriptionDefault
organizationIdYesOrganization ID

Implementation Reference

  • Handler function that fetches the list of modules from the API for the given organization ID and returns the JSON response as text content.
      async ({ organizationId }) => {
        const response = await fetch(`${CONFIG.apiUrl}/organization/${organizationId}/module`, {
          headers: {
            Authorization: `Bearer ${CONFIG.patToken}`,
            "Content-Type": "application/vnd.api+json"
          }
        });
    
        if (!response.ok) {
          throw new Error(`Failed to list modules: ${response.statusText}`);
        }
    
        const data = await response.json();
        return {
          content: [{
            type: "text",
            text: JSON.stringify(data, null, 2)
          }]
        };
      }
    );
  • Input schema for the tool, requiring an organizationId string.
    {
      organizationId: z.string().describe("Organization ID")
    },
  • Direct registration of the 'list-modules' tool on the MCP server, including schema and handler.
    server.tool(
      "list-modules",
      "Lists all modules in the specified organization",
      {
        organizationId: z.string().describe("Organization ID")
      },
      async ({ organizationId }) => {
        const response = await fetch(`${CONFIG.apiUrl}/organization/${organizationId}/module`, {
          headers: {
            Authorization: `Bearer ${CONFIG.patToken}`,
            "Content-Type": "application/vnd.api+json"
          }
        });
    
        if (!response.ok) {
          throw new Error(`Failed to list modules: ${response.statusText}`);
        }
    
        const data = await response.json();
        return {
          content: [{
            type: "text",
            text: JSON.stringify(data, null, 2)
          }]
        };
      }
    );
  • src/index.ts:24-24 (registration)
    Top-level call to registerModuleTools, which registers the 'list-modules' tool among others.
    registerModuleTools(server);
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. While 'Lists' implies a read-only operation, it doesn't specify whether this requires authentication, returns paginated results, includes metadata, or has rate limits. For a tool with zero annotation coverage, this leaves significant behavioral gaps.

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's appropriately sized and front-loaded, with every word earning its place by conveying essential information.

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

Completeness3/5

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

Given the tool's low complexity (single parameter, no output schema, no annotations), the description is minimally adequate but incomplete. It covers the basic purpose but lacks behavioral details and usage guidelines that would help an agent use it effectively. Without annotations or output schema, more context about what 'lists' entails would be beneficial.

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?

The schema description coverage is 100%, with the single parameter 'organizationId' clearly documented in the schema. The description adds no additional parameter information beyond what's in the schema, such as format examples or constraints. With high schema coverage, the baseline score of 3 is appropriate.

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 action ('Lists') and resource ('all modules in the specified organization'), providing a specific verb+resource combination. However, it doesn't explicitly differentiate from sibling tools like 'get-module' (which likely retrieves a single module) or 'list-organizations' (which lists organizations rather than modules), missing full sibling differentiation.

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?

The description provides no guidance on when to use this tool versus alternatives. It doesn't mention when to choose 'list-modules' over 'get-module' for retrieving module information, or how it relates to other list tools like 'list-variables' or 'list-workspaces'. There's no context about prerequisites 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