functionDetails
Get details about a Terraform provider function.
LABSCO SUMMARY
The argument you half-remember, without leaving the file.
resourceArgumentDetails returns required and optional attributes with their nested blocks, so writing an unfamiliar resource stops being a trip to the registry site and back. providerGuides carries the upgrade notes, which is the page you actually want open when a provider's major version moves under you.
What it is
A Terraform Registry client: with no token it loads 10 read-only tools, and a Terraform Cloud API token in TFC_TOKEN adds fourteen more for organizations, private modules, workspaces and runs. The ten cover providers with their resources, data sources, functions and guides; modules with versions, inputs, outputs and dependencies; and policy libraries.
What you get
- A resource type's full argument set — required and optional attributes, nested blocks, and their descriptions — for a given provider and version
- An example usage of a resource together with the resources related to it
- Provider details by namespace, name and optional version, and every data source a provider exposes
- Module search by query, and a module's metadata: versions, inputs, outputs and dependencies
- Provider functions documented one at a time, and provider guides including version-upgrade guides
- Policy libraries searched, and one read in detail with its latest version
Requirements
npx on your PATH. The registry tools need no credentials; the fourteen Terraform Cloud tools need a Terraform Cloud API token in TFC_TOKEN, and they can create, apply and cancel runs and lock workspaces.
Setup effort
One command — npx -y terraform-mcp-server
USE CASES
01
Writing a resource you have not used before
Read the resource's required and optional attributes with their nested blocks, then look at a worked example and the resources that usually sit alongside it.
02
Choosing a module instead of writing the thing yourself
Search the registry for candidates, then read the shortlist's versions, inputs, outputs and dependencies before you commit a source line.
03
Moving a provider to a new major version
Check what the version actually is, then read the provider's guides — the upgrade notes are where the removed arguments are listed.
04
Finding the data source that already holds the value you need
List everything the provider exposes as a data source rather than hardcoding an ID, and check the provider functions for the transform you were about to write in HCL.
05
Checking what policy libraries exist for a provider
Search the registry's policy libraries and read the one you settle on, including its latest version, before writing rules by hand.
10 tools
Counted once with only startup setup. Other versions, modes or optional credentials may expose a different list.
listDataSources
List all available data sources for a provider and their basic details.
moduleDetails
Retrieves detailed metadata for a Terraform module including versions, inputs, outputs, and dependencies.
moduleSearch
Search for and recommend Terraform modules based on a query.
policyDetails
Get detailed information about a specific policy library including its latest version.
policySearch
Search for policy libraries in the Terraform Registry.
providerDetails
Get detailed information about a Terraform provider by name and optionally version.
providerGuides
List and view provider-specific guides, including version upgrades and feature guides.
resourceArgumentDetails
Fetches comprehensive details about a specific resource type's arguments, including required and optional attributes, nested blocks, and their descriptions.
resourceUsage
Get an example usage of a Terraform resource and related resources.
BEFORE YOU INSTALL
What to know first
Tools you get
10 tools when we connected; the project documents 24. Without TFC_TOKEN only the ten public-registry read tools load; a Terraform Cloud API token adds fourteen more, including createRun, applyRun, cancelRun, lockWorkspace and unlockWorkspace. Calling the prompts directly may crash the server.
Requires
npx on PATH
Where it runs
The documented client runs the server on your machine.
INSTALLATION
Connect your client
Server setup
TERMINAL
npx -y terraform-mcp-serverMCP Clients
Claude Desktop
CLAUDE DESKTOP · JSON
{
"mcpServers": {
"terraform-registry": {
"command": "npx",
"args": [
"-y",
"terraform-mcp-server"
]
}
}
}
