Be the first to get access to new connectors. Get early access →
ConnectorBay Early access

HCP Terraform (BYOK) — connector documentation

  • MCP endpoint: https://byok-terraformcloud.connectorbay.com/mcp
  • REST API: POST https://byok-terraformcloud.connectorbay.com/v1/tools/{tool_name}, described by the OpenAPI 3.1 spec at https://byok-terraformcloud.connectorbay.com/openapi.json
  • Transport: Streamable HTTP, stateless, MCP specification 2025-06-18 or later
  • Authentication: your own HCP Terraform user, team or organization API token, sent in the X-Upstream-Key header of every request (never stored, logged or cached)
  • Health: https://byok-terraformcloud.connectorbay.com/health · Tool schemas: https://byok-terraformcloud.connectorbay.com/tools.json
  • Publisher: Unify Dynamics LLC · connectorbay.com/byok-terraformcloud · agent@connectorbay.com

What HCP Terraform (BYOK) is for

HCP Terraform (BYOK) lets an AI assistant read your own HCP Terraform data through the HCP Terraform API with a key you supply (user, team or organization API token). Read-only: 7 tools (list_organizations, get_organization, list_projects, list_workspaces, get_workspace, list_workspace_runs, get_run). The BYOK key travels with each request, is used for that one call only and is never stored, logged or cached; it is only ever sent to app.terraform.io. Unofficial connector by Unify Dynamics LLC: not affiliated with, endorsed by or sponsored by HCP Terraform. HCP Terraform and its logos are trademarks of their owners and are used only to say which service the connector works with.

Ask your assistant things like:

  • "Which HCP Terraform organizations can I access?"
  • "Show settings of my HCP Terraform organization"
  • "What projects exist in my HCP Terraform organization?"
  • "Which HCP Terraform workspaces are locked or failing?"
  • "Show details of an HCP Terraform workspace"
  • "What were the latest runs in my HCP Terraform workspace and did they succeed?"

What it does

  • list_organizations: List the HCP Terraform organizations the token can see with name, creation date and plan flags.
  • get_organization: Get one HCP Terraform organization: plan flags, default execution mode, SAML and cost estimation settings.
  • list_projects: List projects of an HCP Terraform organization with workspace and team counts.
  • list_workspaces: List workspaces of an HCP Terraform organization with execution mode, Terraform version, lock state, resource count and last change.
  • get_workspace: Get one HCP Terraform workspace by organization and name: settings, lock state, resource count, Terraform version and current run id.
  • list_workspace_runs: List runs of an HCP Terraform workspace (newest first) with status, message, source, trigger reason and timestamps. Plan-only runs are excluded unless filtered in.
  • get_run: Get one HCP Terraform run by id: status, message, source, trigger reason, destroy and plan-only flags and timestamps.

BYOK key

You bring your own HCP Terraform user, team or organization API token (https://app.terraform.io/app/settings/tokens). Your assistant sends it in the X-Upstream-Key header with each request. ConnectorBay uses it for that one call only: it is never stored, logged or cached, never shown in an answer, and it is only sent to app.terraform.io over https, with no redirects followed. Create a key with the fewest permissions the tools need (read-only if the provider offers it), and revoke it at the provider whenever you like.

Data sources

Live from the HCP Terraform API (app.terraform.io) with a BYOK key; documentation: https://developer.hashicorp.com/terraform/cloud-docs/api-docs. Endpoints checked against that documentation on 2026-10-16.

What it is not

Unofficial connector by Unify Dynamics LLC: not affiliated with, endorsed by or sponsored by HCP Terraform. HCP Terraform and its logos are trademarks of their owners and are used only to say which service the connector works with. It is read-only: it never creates, changes, sends or deletes anything in your HCP Terraform account.

Built for: Worldwide. Languages: English.