get_workspace_details

Retrieve comprehensive details for a Terraform Cloud workspace by ID or organization and workspace name. Access configuration, VCS settings, execution mode, and status to verify settings or assess the workspace state.

Instructions

Get details for a specific workspace, identified either by ID or by org name and workspace name.

Retrieves comprehensive information about a workspace including its configuration,
VCS settings, execution mode, and other attributes. This is useful for checking
workspace settings before operations or determining the current state of a workspace.

The workspace can be identified either by its ID directly, or by the combination
of organization name and workspace name.

API endpoint:
- GET /workspaces/{workspace_id} (when using workspace_id)
- GET /organizations/{organization}/workspaces/{workspace_name} (when using org+name)

Args:
    workspace_id: The ID of the workspace (format: "ws-xxxxxxxx")
    organization: The name of the organization (required if workspace_id not provided)
    workspace_name: The name of the workspace (required if workspace_id not provided)

Returns:
    Comprehensive workspace details including settings, configuration and status

See:
    docs/tools/workspace_tools.md for usage examples

Input Schema

Name	Required	Description	Default
`organization`	No
`workspace_id`	No
`workspace_name`	No

Input Schema (JSON Schema)

{
  "properties": {
    "organization": {
      "default": "",
      "title": "Organization",
      "type": "string"
    },
    "workspace_id": {
      "default": "",
      "title": "Workspace Id",
      "type": "string"
    },
    "workspace_name": {
      "default": "",
      "title": "Workspace Name",
      "type": "string"
    }
  },
  "title": "get_workspace_detailsArguments",
  "type": "object"
}

terraform-cloud-mcp

get_workspace_details

Instructions

Input Schema

Input Schema (JSON Schema)

Other Tools from terraform-cloud-mcp

Related Tools