get_organization_entitlements
Retrieve organization entitlement details, including feature limits and subscription tier information, via the Terraform Cloud API to manage infrastructure features effectively.
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
| Name | Required | Description | Default |
|---|---|---|---|
| organization | Yes |
Input Schema (JSON Schema)
{
"properties": {
"organization": {
"title": "Organization",
"type": "string"
}
},
"required": [
"organization"
],
"type": "object"
}
Implementation Reference
- The main handler function that executes the tool logic by creating a request model and calling the Terraform Cloud API to retrieve 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 input schema model that validates the 'organization' parameter for 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]$", )
- terraform_cloud_mcp/server.py:76-76 (registration)Tool registration using the FastMCP mcp.tool() decorator.mcp.tool()(organizations.get_organization_entitlements)