Terraform Registry MCP server

This MCP server provides tools for interacting with the Terraform Registry API, allowing AI agents to query provider information, resource details, and module metadata through the Model Context Protocol.

Installation

Installing in Cursor

To install and use this MCP server in Cursor:

1. In Cursor, open Settings (⌘+,) and navigate to the "MCP" tab

2. Click "+ Add new MCP server"

3. Enter the following:

   • Name: terraform-registry
   • Type: command
   • Command: npx -y terraform-mcp-server

4. Click "Add" then scroll to the server and click "Disabled" to enable the server

5. 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:

1. In Claude Desktop, open Settings (⌘+,) and navigate to the "Developer" tab

2. Click "Edit Config" at the bottom of the window

3. Edit the file (~/Library/Application Support/Claude/claude_desktop_config.json) to add the following code, then Save the file:

{
  "mcpServers": {
    "terraform-registry": {
      "command": "npx",
      "args": ["-y", "terraform-mcp-server"]
    }
  }
}

4. Restart Claude Desktop to ensure the MCP server is properly loaded

Available Tools

Core Registry Tools

The MCP server provides several tools for interacting with the Terraform Registry:

• 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):

• 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:

Provider Resources

• terraform:providers - List all namespaces/providers
• terraform:provider:<namespace>/<name> - Get details for a specific provider
• terraform:provider:<namespace>/<name>/versions - List available versions for a provider
• terraform:provider:<namespace>/<name>/resources - List resources for a provider
• terraform:resource:<namespace>/<name>/<resource_name> - Get details for a specific resource type

Data Sources and Functions

• 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
• 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:provider
• terraform:resource
• terraform:dataSource

Prompts

The following prompts are available for generating contextual responses:

• migrate-clouds: Generate Terraform code to migrate infrastructure between cloud providers

  • Required: sourceCloud, targetCloud, terraformCode

• generate-resource-skeleton: Helps users quickly scaffold new Terraform resources with best practices

  • Required: resourceType

• optimize-terraform-module: Provides actionable recommendations for improving Terraform code

  • Required: terraformCode

• migrate-provider-version: Assists with provider version upgrades and breaking changes

  • Required: providerName, currentVersion, targetVersion, terraformCode (optional)

• analyze-workspace-runs: Analyzes recent run failures and provides troubleshooting guidance

  • Required: workspaceId, runsToAnalyze (optional, default: 5)

Known Issues with Prompts

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.

Configuration

The server can be configured using environment variables:

Example Configuration

# Set environment variables
export LOG_LEVEL="debug"
export REQUEST_TIMEOUT_MS="15000"
export TFC_TOKEN="your-terraform-cloud-token"

# Run the server
npm start

How to add this MCP server to Cursor

There are two ways to add an MCP server to Cursor. The most common way is to add the server globally in the ~/.cursor/mcp.json file so that it is available in all of your projects.

If you only need the server in a single project, you can add it to the project instead by creating or adding it to the .cursor/mcp.json file.

Adding an MCP server to Cursor globally

To add a global MCP server go to Cursor Settings > MCP and click "Add new global MCP server".

When you click that button the ~/.cursor/mcp.json file will be opened and you can add your server like this:

{
    "mcpServers": {
        "cursor-rules-mcp": {
            "command": "npx",
            "args": [
                "-y",
                "cursor-rules-mcp"
            ]
        }
    }
}

Adding an MCP server to a project

To add an MCP server to a project you can create a new .cursor/mcp.json file or add it to the existing one. This will look exactly the same as the global MCP server example above.

How to use the MCP server

Once the server is installed, you might need to head back to Settings > MCP and click the refresh button.

The Cursor agent will then be able to see the available tools the added MCP server has available and will call them when it needs to.

You can also explictly ask the agent to use the tool by mentioning the tool name and describing what the function does.