Skip to main content
Glama
severity1

terraform-cloud-mcp

get_organization_entitlements

Retrieve organization subscription details and feature limits from Terraform Cloud to understand available capabilities and entitlements.

Instructions

Show entitlement set for organization features

Retrieves information about available features and capabilities based on the organization's subscription tier.

API endpoint: GET /organizations/{organization}/entitlement-set

Args: organization: The organization name to retrieve entitlements for (required)

Returns: Entitlement set details including feature limits and subscription information

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

Input Schema

TableJSON Schema
NameRequiredDescriptionDefault
organizationYes

Implementation Reference

  • The handler function that executes the tool logic by creating a request model and calling the Terraform Cloud API to fetch organization entitlements.
    @handle_api_errors
    async def get_organization_entitlements(organization: str) -> APIResponse:
        """Show entitlement set for organization features
    
        Retrieves information about available features and capabilities based on
        the organization's subscription tier.
    
        API endpoint: GET /organizations/{organization}/entitlement-set
    
        Args:
            organization: The organization name to retrieve entitlements for (required)
    
        Returns:
            Entitlement set details including feature limits and subscription information
    
        See:
            docs/tools/organization.md for reference documentation
        """
        request = OrganizationEntitlementsRequest(organization=organization)
        return await api_request(f"organizations/{request.organization}/entitlement-set")
  • Pydantic schema/model for input validation of the organization parameter used in the tool.
    class OrganizationEntitlementsRequest(APIRequest):
        """Request model for getting organization entitlements.
    
        This model is used for the GET /organizations/{name}/entitlement-set endpoint.
        The endpoint returns information about which features and capabilities are
        available to the organization based on its subscription tier.
    
        Reference: https://developer.hashicorp.com/terraform/cloud-docs/api-docs/organizations#show-the-entitlement-set
    
        See:
            docs/models/organization.md for reference
        """
    
        organization: str = Field(
            ...,
            # No alias needed as field name matches API field name
            description="The name of the organization to retrieve entitlements for",
            min_length=3,
            pattern=r"^[a-z0-9][-a-z0-9_]*[a-z0-9]$",
        )
  • MCP tool registration of the get_organization_entitlements handler function.
    mcp.tool()(organizations.get_organization_entitlements)
Behavior2/5

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

With no annotations provided, the description carries full burden for behavioral disclosure. It states this is a retrieval operation ('show', 'retrieves') which implies read-only behavior, but doesn't explicitly confirm it's non-destructive. It mentions the API endpoint but doesn't describe authentication requirements, rate limits, error conditions, or response format details beyond 'Entitlement set details'.

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 well-structured with clear sections (purpose, API endpoint, Args, Returns, See). It's appropriately sized for a single-parameter tool, though the 'See' reference could be considered extraneous. Most sentences earn their place by adding value beyond what's in the schema.

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?

For a read-only tool with 1 parameter and no output schema, the description provides adequate but minimal context. It explains what the tool does and the parameter meaning, but lacks details about the return structure ('Entitlement set details' is vague), authentication, or error handling. Without annotations or output schema, more behavioral context would be helpful.

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 description adds meaningful context for the single parameter: 'organization: The organization name to retrieve entitlements for (required)'. With 0% schema description coverage and only 1 parameter, this adequately compensates by explaining what the parameter represents and that it's required. The schema itself only provides type information without description.

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 tool's purpose: 'Show entitlement set for organization features' and 'Retrieves information about available features and capabilities based on the organization's subscription tier.' It specifies the verb ('show', 'retrieves'), resource ('entitlement set'), and scope ('organization features'), but doesn't explicitly differentiate from sibling tools like 'get_organization_details' or 'list_organizations'.

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 sibling tools like 'get_organization_details' or clarify whether this is for subscription-specific information versus general organization metadata. Usage context is implied but not explicit.

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