Skip to main content
Glama
deenesjakoruzh
severity1

terraform-cloud-mcp

by severity1
OverviewSchemaRelated ServersScoreDiscussions
Python
Remote

get_state_version_output

Retrieve state version output details including name, value, type, and sensitivity information from Terraform Cloud to analyze infrastructure configuration results.

Instructions

Get details for a specific state version output.

Retrieves comprehensive information about a state version output including its name, value, type, and sensitivity information.

API endpoint: GET /state-version-outputs/:state_version_output_id

Args: state_version_output_id: The ID of the state version output (format: "wsout-xxxxxxxx")

Returns: State version output details including name, value, type, and sensitivity information

See: docs/tools/state_version_outputs.md for reference documentation

Input Schema

TableJSON Schema
NameRequiredDescriptionDefault
state_version_output_idYes

Implementation Reference

  • terraform_cloud_mcp/tools/state_version_outputs.py:57-80 (handler)
    The main handler function that executes the tool logic: validates input using StateVersionOutputRequest model and calls the Terraform Cloud API to retrieve details for the specified state version output.
    @handle_api_errors
async def get_state_version_output(state_version_output_id: str) -> APIResponse:
    """Get details for a specific state version output.

    Retrieves comprehensive information about a state version output including
    its name, value, type, and sensitivity information.

    API endpoint: GET /state-version-outputs/:state_version_output_id

    Args:
        state_version_output_id: The ID of the state version output (format: "wsout-xxxxxxxx")

    Returns:
        State version output details including name, value, type, and sensitivity information

    See:
        docs/tools/state_version_outputs.md for reference documentation
    """
    # Validate parameters
    params = StateVersionOutputRequest(state_version_output_id=state_version_output_id)

    # Make API request
    return await api_request(f"state-version-outputs/{params.state_version_output_id}")
  • terraform_cloud_mcp/server.py:121-121 (registration)
    Registers the get_state_version_output tool function with the FastMCP server instance.
    mcp.tool()(state_version_outputs.get_state_version_output)

Tool Definition Quality

A4.1/5.0
Behavior3/5

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

With no annotations provided, the description carries the full burden. It discloses the tool is a retrieval operation ('Get details', 'Retrieves comprehensive information'), which implies it's read-only and non-destructive. However, it doesn't mention authentication requirements, rate limits, error conditions, or response format details beyond high-level fields.

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

Conciseness4/5

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

The description is appropriately sized and front-loaded with the core purpose in the first sentence. The API endpoint reference and 'See' section are useful but could be considered slightly extraneous; however, they don't significantly detract from clarity.

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

Completeness4/5

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

For a single-parameter read tool with no output schema, the description is reasonably complete. It explains what the tool does, what parameter it needs, and what information it returns. It could benefit from more behavioral details (e.g., error handling), but covers the essentials given the tool's simplicity.

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

Parameters4/5

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

The schema has 0% description coverage, but the description compensates well. It explains the single parameter 'state_version_output_id' as 'The ID of the state version output' and provides the exact format ('wsout-xxxxxxxx'), which adds crucial meaning beyond the schema's basic string type.

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

Purpose5/5

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

The description clearly states the specific action ('Get details for a specific state version output') and resource ('state version output'), distinguishing it from siblings like 'list_state_version_outputs' (which lists multiple) and 'get_state_version' (which gets the version itself, not its outputs). It explicitly mentions retrieving comprehensive information including name, value, type, and sensitivity.

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

Usage Guidelines4/5

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

The description implies usage context by specifying it's for a 'specific' state version output, suggesting it should be used when you have a known ID. It doesn't explicitly state when not to use it or name alternatives, but the specificity provides clear guidance compared to list operations.

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

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/severity1/terraform-cloud-mcp'

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