{"openapi":"3.1.0","info":{"title":"HCP Terraform Workspace Links (BYOK) API","version":"0.1.0","description":"HCP Terraform Workspace Links (BYOK) lets an AI assistant read your own HCP Terraform Workspace Links data through the HCP Terraform Workspace Links API with a key you supply (user, team or organization API token). Read-only: 6 tools (list_workspace_tags, list_workspace_tag_bindings, list_workspace_effective_tag_bindings, list_project_tag_bindings, list_remote_state_consumers,...\n\nEvery operation is read-only or compute-only. The same tools are available over MCP (streamable HTTP) at https://byok-hcp-terraform-workspace-links.connectorbay.com/mcp.","contact":{"name":"Unify Dynamics LLC","email":"agent@connectorbay.com","url":"https://connectorbay.com/byok-hcp-terraform-workspace-links/docs"},"termsOfService":"https://connectorbay.com/byok-hcp-terraform-workspace-links/terms"},"servers":[{"url":"https://byok-hcp-terraform-workspace-links.connectorbay.com"}],"externalDocs":{"url":"https://connectorbay.com/byok-hcp-terraform-workspace-links/docs"},"security":[{"upstreamKey":[]}],"components":{"securitySchemes":{"bearer":{"type":"http","scheme":"bearer","description":"Optional. A Pro API key raises rate limits; no credentials are required."},"upstreamKey":{"type":"apiKey","in":"header","name":"X-Upstream-Key","description":"Your own key for the service this connector wraps (bring your own key). Used for that one call only; never stored, logged or cached."}},"schemas":{"Error":{"type":"object","properties":{"ok":{"const":false},"error":{"type":"object"}}}}},"paths":{"/v1/tools/list_workspace_tags":{"post":{"operationId":"list_workspace_tags","summary":"List the flat string tags attached to a workspace with the number of workspaces using each tag. Use for \"Which tags does","description":"List the flat string tags attached to a workspace with the number of workspaces using each tag. Use for \"Which tags does HCP Terraform workspace ws-db61c9eb5cab5ae2 have\".","tags":["tools"],"requestBody":{"required":true,"content":{"application/json":{"schema":{"properties":{"workspace_id":{"description":"Workspace id (ws-...), as returned by list_workspaces in the HCP Terraform connector.","maxLength":60,"title":"Workspace Id","type":"string"},"page_size":{"anyOf":[{"maximum":100,"minimum":1,"type":"integer"},{"type":"null"}],"default":20,"description":"Items per page (1 to 100, default 20).","title":"Page Size"},"page_number":{"anyOf":[{"maximum":100000,"minimum":1,"type":"integer"},{"type":"null"}],"default":1,"description":"Page number, starting at 1.","title":"Page Number"}},"required":["workspace_id"],"title":"list_workspace_tagsArguments","type":"object"}}}},"responses":{"200":{"description":"Tool result. `ok: true` on success; `ok: false` with a structured `error` (provider_unavailable, upstream_error, bad_input) when the tool could not answer.","content":{"application/json":{"schema":{"type":"object","additionalProperties":true}}}},"422":{"description":"Arguments failed validation","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Error"}}}},"429":{"description":"Rate limit exceeded (see Retry-After)","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Error"}}}}},"x-read-only":true}},"/v1/tools/list_workspace_tag_bindings":{"post":{"operationId":"list_workspace_tag_bindings","summary":"List the key-value tags bound directly to a workspace (for example costcenter=123). Use for \"Which key-value tags are se","description":"List the key-value tags bound directly to a workspace (for example costcenter=123). Use for \"Which key-value tags are set directly on HCP Terraform workspace ws-db61c9eb5cab5ae2\".","tags":["tools"],"requestBody":{"required":true,"content":{"application/json":{"schema":{"properties":{"workspace_id":{"description":"Workspace id (ws-...), as returned by list_workspaces in the HCP Terraform connector.","maxLength":60,"title":"Workspace Id","type":"string"}},"required":["workspace_id"],"title":"list_workspace_tag_bindingsArguments","type":"object"}}}},"responses":{"200":{"description":"Tool result. `ok: true` on success; `ok: false` with a structured `error` (provider_unavailable, upstream_error, bad_input) when the tool could not answer.","content":{"application/json":{"schema":{"type":"object","additionalProperties":true}}}},"422":{"description":"Arguments failed validation","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Error"}}}},"429":{"description":"Rate limit exceeded (see Retry-After)","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Error"}}}}},"x-read-only":true}},"/v1/tools/list_workspace_effective_tag_bindings":{"post":{"operationId":"list_workspace_effective_tag_bindings","summary":"List all key-value tags that apply to a workspace, including those inherited from its project. Use for \"Which key-value ","description":"List all key-value tags that apply to a workspace, including those inherited from its project. Use for \"Which key-value tags apply to HCP Terraform workspace ws-db61c9eb5cab5ae2 including project tags\".","tags":["tools"],"requestBody":{"required":true,"content":{"application/json":{"schema":{"properties":{"workspace_id":{"description":"Workspace id (ws-...), as returned by list_workspaces in the HCP Terraform connector.","maxLength":60,"title":"Workspace Id","type":"string"}},"required":["workspace_id"],"title":"list_workspace_effective_tag_bindingsArguments","type":"object"}}}},"responses":{"200":{"description":"Tool result. `ok: true` on success; `ok: false` with a structured `error` (provider_unavailable, upstream_error, bad_input) when the tool could not answer.","content":{"application/json":{"schema":{"type":"object","additionalProperties":true}}}},"422":{"description":"Arguments failed validation","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Error"}}}},"429":{"description":"Rate limit exceeded (see Retry-After)","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Error"}}}}},"x-read-only":true}},"/v1/tools/list_project_tag_bindings":{"post":{"operationId":"list_project_tag_bindings","summary":"List the key-value tags bound to a project, which its workspaces inherit. Use for \"Which key-value tags are set on HCP T","description":"List the key-value tags bound to a project, which its workspaces inherit. Use for \"Which key-value tags are set on HCP Terraform project prj-Lg4wmRZEpDUf8ZhB\".","tags":["tools"],"requestBody":{"required":true,"content":{"application/json":{"schema":{"properties":{"project_id":{"description":"Project id (prj-...), as returned by list_projects in the HCP Terraform connector.","maxLength":60,"title":"Project Id","type":"string"}},"required":["project_id"],"title":"list_project_tag_bindingsArguments","type":"object"}}}},"responses":{"200":{"description":"Tool result. `ok: true` on success; `ok: false` with a structured `error` (provider_unavailable, upstream_error, bad_input) when the tool could not answer.","content":{"application/json":{"schema":{"type":"object","additionalProperties":true}}}},"422":{"description":"Arguments failed validation","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Error"}}}},"429":{"description":"Rate limit exceeded (see Retry-After)","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Error"}}}}},"x-read-only":true}},"/v1/tools/list_remote_state_consumers":{"post":{"operationId":"list_remote_state_consumers","summary":"List the workspaces allowed to read a workspace's state during runs (all workspaces the token can read when global remot","description":"List the workspaces allowed to read a workspace's state during runs (all workspaces the token can read when global remote state is on). Use for \"Which workspaces can read the state of HCP Terraform workspace ws-db61c9eb5cab5ae2\".","tags":["tools"],"requestBody":{"required":true,"content":{"application/json":{"schema":{"properties":{"workspace_id":{"description":"Workspace id (ws-...), as returned by list_workspaces in the HCP Terraform connector.","maxLength":60,"title":"Workspace Id","type":"string"},"page_size":{"anyOf":[{"maximum":100,"minimum":1,"type":"integer"},{"type":"null"}],"default":20,"description":"Items per page (1 to 100, default 20).","title":"Page Size"},"page_number":{"anyOf":[{"maximum":100000,"minimum":1,"type":"integer"},{"type":"null"}],"default":1,"description":"Page number, starting at 1.","title":"Page Number"}},"required":["workspace_id"],"title":"list_remote_state_consumersArguments","type":"object"}}}},"responses":{"200":{"description":"Tool result. `ok: true` on success; `ok: false` with a structured `error` (provider_unavailable, upstream_error, bad_input) when the tool could not answer.","content":{"application/json":{"schema":{"type":"object","additionalProperties":true}}}},"422":{"description":"Arguments failed validation","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Error"}}}},"429":{"description":"Rate limit exceeded (see Retry-After)","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Error"}}}}},"x-read-only":true}},"/v1/tools/get_assessment_result":{"post":{"operationId":"get_assessment_result","summary":"Get the summary of one health assessment: whether drift was detected, whether it succeeded, any error message and when i","description":"Get the summary of one health assessment: whether drift was detected, whether it succeeded, any error message and when it ran (Standard and Premium editions). Use for \"Did health assessment asmtres-cHh5777xm detect drift\".","tags":["tools"],"requestBody":{"required":true,"content":{"application/json":{"schema":{"properties":{"assessment_result_id":{"description":"Assessment result id (asmtres-...), as shown in a workspace's current-assessment-result relationship.","maxLength":60,"title":"Assessment Result Id","type":"string"}},"required":["assessment_result_id"],"title":"get_assessment_resultArguments","type":"object"}}}},"responses":{"200":{"description":"Tool result. `ok: true` on success; `ok: false` with a structured `error` (provider_unavailable, upstream_error, bad_input) when the tool could not answer.","content":{"application/json":{"schema":{"type":"object","additionalProperties":true}}}},"422":{"description":"Arguments failed validation","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Error"}}}},"429":{"description":"Rate limit exceeded (see Retry-After)","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Error"}}}}},"x-read-only":true}}}}