A
securityA
licenseA
qualityEnhances Claude AI with persistent memory storage for Infrastructure-as-Code components, supporting version tracking and relationship mapping for Terraform and Ansible resources.
Last updated -
23
4
Python
MIT License
The Terraform Registry MCP Server enables AI agents to interact with the Terraform Registry and Terraform Cloud APIs, providing a comprehensive interface for Terraform resource management:
- Query provider information: Lookup details for public and private Terraform providers by name, version, and namespace
- Access resource documentation: Get example usage, detailed arguments, and related resources for Terraform resources and data sources
- Search and manage modules: Find, recommend, and retrieve detailed metadata for Terraform modules, including versions, inputs, outputs, and dependencies
- Terraform Cloud integration: List and manage organizations, workspaces, runs, and workspace resources (requires TFC_TOKEN)
- Access documentation: Retrieve provider-specific guides and policy libraries
- Generate templates: Get templates for creating provider, resource, and data source definitions
- Utilize generative prompts: Get assistance with cloud migration, resource scaffolding, code optimization, and more
Enables access to HashiCorp's Terraform Registry, allowing lookup of HashiCorp-provided providers and modules, with detailed information on their configuration, requirements, and usage examples.
Provides tools for interacting with the Terraform Registry API, enabling querying of provider information, resource details, module metadata, and recommendations. Supports looking up providers, retrieving resource usage examples, finding modules, listing data sources, and fetching comprehensive resource argument details.
Terraform Registry MCP Server
A Model Context Protocol (MCP) server that provides tools for interacting with the Terraform Registry API. This server enables AI agents to query provider information, resource details, and module metadata.
Important
This project was used as a PoC for a new official Terraform MCP server. This repo has been archived in favor of that one.
Installation
Installing in Cursor
To install and use this MCP server in Cursor:
- In Cursor, open Settings (⌘+,) and navigate to the "MCP" tab.
- Click "+ Add new MCP server."
- Enter the following:
- Name: terraform-registry
- Type: command
- Command: npx -y terraform-mcp-server
- Click "Add" then scroll to the server and click "Disabled" to enable the server.
- Restart Cursor, if needed, to ensure the MCP server is properly loaded.
Installing in Claude Desktop
To install and use this MCP server in Claude Desktop:
- In Claude Desktop, open Settings (⌘+,) and navigate to the "Developer" tab.
- Click "Edit Config" at the bottom of the window.
- Edit the file (
~/Library/Application Support/Claude/claude_desktop_config.json) to add the following code, then Save the file.
- Restart Claude Desktop to ensure the MCP server is properly loaded.
Tools
The following tools are available in this MCP server:
Core Registry Tools
| Tool | Description |
|---|---|
providerDetails | Gets detailed information about a Terraform provider |
resourceUsage | Gets example usage of a Terraform resource and related resources |
moduleSearch | Searches for and recommends Terraform modules based on a query |
listDataSources | Lists all available data sources for a provider and their basic details |
resourceArgumentDetails | Fetches comprehensive details about a resource type's arguments |
moduleDetails | Retrieves detailed metadata for a Terraform module |
functionDetails | Gets details about a Terraform provider function |
providerGuides | Lists and views provider-specific guides and documentation |
policySearch | Searches for policy libraries in the Terraform Registry |
policyDetails | Gets detailed information about a specific policy library |
Terraform Cloud Tools
These tools require a Terraform Cloud API token (TFC_TOKEN):
| Tool | Description |
|---|---|
listOrganizations | Lists all organizations the authenticated user has access to |
privateModuleSearch | Searches for private modules in an organization |
privateModuleDetails | Gets detailed information about a private module |
explorerQuery | Queries the Terraform Cloud Explorer API to analyze data |
listWorkspaces | Lists workspaces in an organization |
workspaceDetails | Gets detailed information about a specific workspace |
lockWorkspace | Locks a workspace to prevent runs |
unlockWorkspace | Unlocks a workspace to allow runs |
listRuns | Lists runs for a workspace |
runDetails | Gets detailed information about a specific run |
createRun | Creates a new run for a workspace |
applyRun | Applies a run that's been planned |
cancelRun | Cancels a run that's in progress |
listWorkspaceResources | Lists resources in a workspace |
Resources
The MCP server supports the following resource URIs for listing and reading via the resources/* methods:
| Resource Type | Example URI(s) | Description |
|---|---|---|
| Providers | terraform:providers | List all namespaces/providers |
terraform:provider:<namespace>/<name> | Get details for a specific provider | |
| Provider Versions | terraform:provider:<namespace>/<name>/versions | List available versions for a provider |
| Provider Resources | terraform:provider:<namespace>/<name>/resources | List resources for a provider |
terraform:resource:<namespace>/<name>/<resource_name> | Get details for a specific resource type | |
| Provider Data Sources | terraform:provider:<namespace>/<name>/dataSources | List data sources for a provider |
terraform:dataSource:<namespace>/<name>/<data_source_name> | Get details for a specific data source | |
| Provider Functions | terraform:provider:<namespace>/<name>/functions | List functions for a provider |
terraform:function:<namespace>/<name>/<function_name> | Get details for a specific function |
The server also supports resources/templates/list to provide templates for creating:
terraform:providerterraform:resourceterraform:dataSource
Prompts
The following prompts are available for generating contextual responses:
| Prompt | Description | Required Arguments |
|---|---|---|
migrate-clouds | Generate Terraform code to migrate infrastructure between cloud providers | sourceCloud, targetCloud, terraformCode |
generate-resource-skeleton | Helps users quickly scaffold new Terraform resources with best practices | resourceType |
optimize-terraform-module | Provides actionable recommendations for improving Terraform code | terraformCode |
migrate-provider-version | Assists with provider version upgrades and breaking changes | providerName, currentVersion, targetVersion, terraformCode (optional) |
analyze-workspace-runs | Analyzes recent run failures and provides troubleshooting guidance for Terraform Cloud workspaces | workspaceId, runsToAnalyze (optional, default: 5) |
Known Issues with Prompts
Note: There is a known issue with the getPrompt functionality that can cause server crashes. The server properly registers prompts and can list them, but direct requests using the getPrompt method may cause connectivity issues. This is being investigated and may be related to SDK compatibility or implementation details. Until resolved, use listPrompts to see available prompts but avoid direct getPrompt calls.
Running the Server
The server runs using stdio transport for MCP communication:
Configuration with Environment Variables
The server can be configured using environment variables:
| Environment Variable | Description | Default Value |
|---|---|---|
TERRAFORM_REGISTRY_URL | Base URL for Terraform Registry API | https://registry.terraform.io |
DEFAULT_PROVIDER_NAMESPACE | Default namespace for providers | hashicorp |
LOG_LEVEL | Logging level (error, warn, info, debug) | info |
REQUEST_TIMEOUT_MS | Timeout for API requests in milliseconds | 10000 |
RATE_LIMIT_ENABLED | Enable rate limiting for API requests | false |
RATE_LIMIT_REQUESTS | Number of requests allowed in time window | 60 |
RATE_LIMIT_WINDOW_MS | Time window for rate limiting in milliseconds | 60000 |
TFC_TOKEN | Terraform Cloud API token for private registry access (optional) |
Example usage with environment variables:
Testing
See the TESTS.md file for information about testing this project.
You must be authenticated.
remote-capable server
The server can be hosted and run remotely because it primarily relies on remote services or has no dependency on the local environment.
Tools
Connects AI models to the Terraform Registry via MCP, enabling provider lookups, resource usage examples, and module recommendations for streamlined Terraform workflows.
Related Resources
Related MCP Servers
- -securityAlicense-quality🌍 Terraform Model Context Protocol (MCP) Tool - An experimental CLI tool that enables AI assistants to manage and operate Terraform environments. Supports reading Terraform configurations, analyzing plans, applying configurations, and managing state with Claude Desktop integration. ⚡️Last updated -239RustMIT License
- AsecurityAlicenseAqualityA Model Context Protocol (MCP) server that integrates Claude with the Terraform Cloud API, allowing Claude to manage your Terraform infrastructure through natural conversation.Last updated -2510PythonMIT License
- -securityAlicense-qualityA lightweight service that enables AI assistants to execute AWS CLI commands through the Model Context Protocol (MCP), allowing AI tools to retrieve AWS documentation and interact with AWS services.Last updated -57PythonMIT License