terraform-cloud-mcp

Instructions

Implementation Reference

• terraform_cloud_mcp/tools/assessment_results.py:15-38 (handler)

  The main handler function that validates input using Pydantic model and fetches assessment result details from Terraform Cloud API.

  @handle_api_errors
  async def get_assessment_result_details(assessment_result_id: str) -> APIResponse:
      """Get details for a specific assessment result.
  
      Retrieves comprehensive information about an assessment result including its current status,
      whether drift was detected, and links to related resources like JSON output and logs.
  
      API endpoint: GET /api/v2/assessment-results/{assessment_result_id}
  
      Args:
          assessment_result_id: The ID of the assessment result to retrieve details for (format: "asmtres-xxxxxxxx")
  
      Returns:
          Assessment result details including status, timestamps, and drift detection information
  
      See:
          docs/tools/assessment_results.md for reference documentation
      """
      # Validate parameters
      params = AssessmentResultRequest(assessment_result_id=assessment_result_id)
  
      # Make API request
      return await api_request(f"assessment-results/{params.assessment_result_id}")

• terraform_cloud_mcp/models/assessment_results.py:39-56 (schema)

  Pydantic model defining and validating the input parameter 'assessment_result_id' with regex pattern for Terraform Cloud assessment result IDs.

  class AssessmentResultRequest(APIRequest):
      """Request model for retrieving assessment result details.
  
      Used to validate the assessment result ID parameter for API requests.
  
      Reference: https://developer.hashicorp.com/terraform/cloud-docs/api-docs/assessment-results#show-assessment-result
  
      See:
          docs/models/assessment_result.md for reference
      """
  
      assessment_result_id: str = Field(
          ...,
          # No alias needed as field name matches API parameter
          description="The ID of the assessment result to retrieve",
          pattern=r"^asmtres-[a-zA-Z0-9]{8,}$",  # Standard assessment result ID pattern
      )

• terraform_cloud_mcp/server.py:107-107 (registration)

  Registers the get_assessment_result_details tool function with the MCP server using FastMCP's tool decorator.

  mcp.tool()(assessment_results.get_assessment_result_details)