Skip to main content
Glama
severity1

terraform-cloud-mcp

get_project_details

Retrieve comprehensive Terraform Cloud project information including configuration, tag bindings, workspace count, and status details.

Instructions

Get details for a specific project.

Retrieves comprehensive information about a project including its configuration, tag bindings, workspace count, and other attributes.

API endpoint: GET /projects/{project_id}

Args: project_id: The ID of the project (format: "prj-xxxxxxxx")

Returns: Project details including settings, configuration and status

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

Input Schema

TableJSON Schema
NameRequiredDescriptionDefault
project_idYes

Implementation Reference

  • The handler function for the 'get_project_details' tool. It takes a project_id and performs a GET request to the Terraform Cloud API at /projects/{project_id} to retrieve project details, returning an APIResponse.
    @handle_api_errors
    async def get_project_details(project_id: str) -> APIResponse:
        """Get details for a specific project.
    
        Retrieves comprehensive information about a project including its configuration,
        tag bindings, workspace count, and other attributes.
    
        API endpoint: GET /projects/{project_id}
    
        Args:
            project_id: The ID of the project (format: "prj-xxxxxxxx")
    
        Returns:
            Project details including settings, configuration and status
    
        See:
            docs/tools/project.md for reference documentation
        """
        # Make API request
        return await api_request(f"projects/{project_id}", method="GET")
  • Registers the get_project_details tool from the projects module using the FastMCP mcp.tool() decorator.
    mcp.tool()(projects.get_project_details)
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 mentions retrieving 'comprehensive information' and lists some attributes (configuration, tag bindings, workspace count), but does not disclose critical behaviors such as authentication requirements, rate limits, error handling, or whether it's a read-only operation. The API endpoint hint ('GET') implies read-only, but this is not explicitly stated in the description text.

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, details, API endpoint, Args, Returns, See), and sentences are front-loaded with key information. It is appropriately sized for a simple retrieval tool, though the 'See' reference could be considered extraneous if not essential for agent use.

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. It covers the purpose and parameter semantics but lacks usage guidelines and full behavioral transparency. Without annotations or output schema, it should ideally provide more context on return values and operational constraints, leaving gaps in completeness.

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 description includes an 'Args' section that documents the single parameter 'project_id' with format details ('prj-xxxxxxxx'), adding value beyond the input schema which has 0% description coverage and only provides a title. However, it does not explain the semantics of the parameter further, such as where to obtain the ID or validation rules. With one parameter and low schema coverage, this partial compensation justifies a baseline score.

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: 'Get details for a specific project' and 'Retrieves comprehensive information about a project'. It specifies the verb ('Get', 'Retrieves') and resource ('project'), but does not explicitly differentiate it from sibling tools like 'get_organization_details' or 'get_workspace_details' beyond the resource name, which is implied but not stated.

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 does not mention sibling tools like 'list_projects' for listing projects or 'update_project' for modifying them, nor does it specify prerequisites or contexts for usage. The 'See' reference to external documentation is not a substitute for inline guidance.

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