terraform-cloud-mcp

Instructions

Implementation Reference

• terraform_cloud_mcp/tools/state_version_outputs.py:19-55 (handler)

  The primary handler function implementing the list_state_version_outputs tool. It validates inputs using StateVersionOutputListRequest, builds query parameters, and makes an API request to the Terraform Cloud /state-versions/{state_version_id}/outputs endpoint.

  @handle_api_errors
  async def list_state_version_outputs(
      state_version_id: str, page_number: int = 1, page_size: int = 20
  ) -> APIResponse:
      """List outputs for a state version.
  
      Retrieves a paginated list of all outputs for a specific state version.
      These outputs include name, value, and sensitivity information.
  
      API endpoint: GET /state-versions/:state_version_id/outputs
  
      Args:
          state_version_id: The ID of the state version (format: "sv-xxxxxxxx")
          page_number: The page number to return (default: 1)
          page_size: The number of items per page (default: 20, max: 100)
  
      Returns:
          Paginated list of state version outputs with name, value, and sensitivity information
  
      See:
          docs/tools/state_version_outputs.md for reference documentation
      """
      # Validate parameters
      params = StateVersionOutputListRequest(
          state_version_id=state_version_id,
          page_number=page_number,
          page_size=page_size,
      )
  
      # Build query parameters using utility function
      query = query_params(params)
  
      # Make API request
      return await api_request(
          f"state-versions/{params.state_version_id}/outputs", params=query
      )

• terraform_cloud_mcp/models/state_version_outputs.py:14-41 (schema)

  Pydantic input schema model StateVersionOutputListRequest used for validating the parameters (state_version_id, page_number, page_size) of the list_state_version_outputs tool.

  class StateVersionOutputListRequest(APIRequest):
      """Request parameters for listing state version outputs.
  
      Defines the parameters for the state version outputs listing API including pagination.
  
      Reference: https://developer.hashicorp.com/terraform/cloud-docs/api-docs/state-version-outputs#list-state-version-outputs
  
      See:
          docs/models/state_version_outputs.md for reference
      """
  
      state_version_id: str = Field(
          ...,
          description="The ID of the state version to list outputs for",
          pattern=r"^sv-[a-zA-Z0-9]{16}$",  # Standard state version ID pattern
      )
      page_number: Optional[int] = Field(
          1,
          ge=1,
          description="Page number to fetch",
      )
      page_size: Optional[int] = Field(
          20,
          ge=1,
          le=100,
          description="Number of results per page",
      )

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

  Registration of the list_state_version_outputs tool in the MCP server using the mcp.tool() decorator.

  mcp.tool()(state_version_outputs.list_state_version_outputs)