terraform-mcp-server

hashicorp/terraform-mcp-server

4.5

terraform-mcp-server is hosted online, so all tools can be tested directly either in theInspector tabor in theOnline Client.

If you are the rightful owner of terraform-mcp-server and would like to certify it and/or have it hosted online, please leave a comment on the right or send an email to henry@mcphub.com.

The Terraform MCP Server is a Model Context Protocol server that integrates with Terraform Registry APIs for advanced automation in Infrastructure as Code development.

Try terraform-mcp-server with chat:

Server config via mcphub

Tools
6
Resources
0
Prompts
0

Terraform MCP Server

The Terraform MCP Server is a Model Context Protocol (MCP) server that provides seamless integration with Terraform Registry APIs, enabling advanced automation and interaction capabilities for Infrastructure as Code (IaC) development.

Features

  • Dual Transport Support: Both Stdio and StreamableHTTP transports
  • Terraform Provider Discovery: Query and explore Terraform providers and their documentation
  • Module Search & Analysis: Search and retrieve detailed information about Terraform modules
  • Registry Integration: Direct integration with Terraform Registry APIs
  • Container Ready: Docker support for easy deployment

Caution: The outputs and recommendations provided by the MCP server are generated dynamically and may vary based on the query, model, and the connected MCP server. Users should thoroughly review all outputs/recommendations to ensure they align with their organization's security best practices, cost-efficiency goals, and compliance requirements before implementation.

Security Note: When using the StreamableHTTP transport in production, always configure the MCP_ALLOWED_ORIGINS environment variable to restrict access to trusted origins only. This helps prevent DNS rebinding attacks and other cross-origin vulnerabilities.

Prerequisites

  1. To run the server in a container, you will need to have Docker installed.
  2. Once Docker is installed, you will need to ensure Docker is running.

Transport Support

The Terraform MCP Server supports multiple transport protocols:

1. Stdio Transport (Default)

Standard input/output communication using JSON-RPC messages. Ideal for local development and direct integration with MCP clients.

2. StreamableHTTP Transport

Modern HTTP-based transport supporting both direct HTTP requests and Server-Sent Events (SSE) streams. This is the recommended transport for remote/distributed setups.

Features:

  • Endpoint: http://{hostname}:8080/mcp
  • Health Check: http://{hostname}:8080/health
  • Environment Configuration: Set TRANSPORT_MODE=http or TRANSPORT_PORT=8080 to enable

Environment Variables:

VariableDescriptionDefault
TRANSPORT_MODESet to streamable-http to enable HTTP transport (legacy http value still supported)stdio
TRANSPORT_HOSTHost to bind the HTTP server127.0.0.1
TRANSPORT_PORTHTTP server port8080
MCP_ENDPOINTHTTP server endpoint path/mcp
MCP_SESSION_MODESession mode: stateful or statelessstateful
MCP_ALLOWED_ORIGINSComma-separated list of allowed origins for CORS"" (empty)
MCP_CORS_MODECORS mode: strict, development, or disabledstrict

Command Line Options

# Stdio mode
terraform-mcp-server stdio [--log-file /path/to/log]

# StreamableHTTP mode
terraform-mcp-server streamable-http [--transport-port 8080] [--transport-host 127.0.0.1] [--mcp-endpoint /mcp] [--log-file /path/to/log]

Session Modes

The Terraform MCP Server supports two session modes when using the StreamableHTTP transport:

  • Stateful Mode (Default): Maintains session state between requests, enabling context-aware operations.
  • Stateless Mode: Each request is processed independently without maintaining session state, which can be useful for high-availability deployments or when using load balancers.

To enable stateless mode, set the environment variable:

export MCP_SESSION_MODE=stateless

Installation

Usage with VS Code

Add the following JSON block to your User Settings (JSON) file in VS Code. You can do this by pressing Ctrl + Shift + P and typing Preferences: Open User Settings (JSON).

More about using MCP server tools in VS Code's agent mode documentation.

{
  "mcp": {
    "servers": {
      "terraform": {
        "command": "docker",
        "args": [
          "run",
          "-i",
          "--rm",
          "hashicorp/terraform-mcp-server"
        ]
      }
    }
  }
}

Optionally, you can add a similar example (i.e. without the mcp key) to a file called .vscode/mcp.json in your workspace. This will allow you to share the configuration with others.

{
  "servers": {
    "terraform": {
      "command": "docker",
      "args": [
        "run",
        "-i",
        "--rm",
        "hashicorp/terraform-mcp-server"
      ]
    }
  }
}

Usage with Claude Desktop / Amazon Q Developer / Amazon Q CLI

More about using MCP server tools in Claude Desktop user documentation. Read more about using MCP server in Amazon Q from the documentation.

{
  "mcpServers": {
    "terraform": {
      "command": "docker",
      "args": [
        "run",
        "-i",
        "--rm",
        "hashicorp/terraform-mcp-server"
      ]
    }
  }
}

Tool Configuration

Available Toolsets

The following sets of tools are available for the public Terraform registry:

ToolsetToolDescription
providerssearch_providersQueries the Terraform Registry to find and list available documentation for a specific provider using the specified service_slug. Returns a list of provider document IDs with their titles and categories for resources, data sources, functions, or guides.
providersget_provider_detailsFetches the complete documentation content for a specific provider resource, data source, or function using a document ID obtained from the search_providers tool. Returns the raw documentation in markdown format.
providersget_latest_provider_versionFetches the complete documentation content for a specific provider resource, data source, or function using a document ID obtained from the search_providers tool. Returns the raw documentation in markdown format.
modulessearch_modulesSearches the Terraform Registry for modules based on specified module_query with pagination. Returns a list of module IDs with their names, descriptions, download counts, verification status, and publish dates
modulesget_module_detailsRetrieves detailed documentation for a module using a module ID obtained from the search_modules tool including inputs, outputs, configuration, submodules, and examples.
modulesget_latest_module_versionRetrieves detailed documentation for a module using a module ID obtained from the search_modules tool including inputs, outputs, configuration, submodules, and examples.
policiessearch_policiesQueries the Terraform Registry to find and list the appropriate Sentinel Policy based on the provided query policy_query. Returns a list of matching policies with terraform_policy_id(s) with their name, title and download counts.
policiesget_policy_detailsRetrieves detailed documentation for a policy set using a terraform_policy_id obtained from the search_policies tool including policy readme and implementation details.

The following sets of tools are available for HCP Terraform or Terraform Enterprise:

ToolsetToolDescription
orgslist_organizationsLists all Terraform organizations accessible to the authenticated user.
projectslist_projectsLists all projects within a specified Terraform organization.

Resource Configuration

Available resources

Resource URIDescription
/terraform/style-guideTerraform Style Guide - Provides access to the official Terraform style guide documentation in markdown format
/terraform/module-developmentTerraform Module Development Guide - Comprehensive guide covering module composition, structure, providers, publishing, and refactoring best practices

Available Resource Templates

Resouce Template URIDescription
/terraform/providers/{namespace}/name/{name}/version/{version}Provider Resource Template - Dynamically retrieves detailed documentation and overview for any Terraform provider by namespace, name, and version

Install from source

Use the latest release version:

go install github.com/hashicorp/terraform-mcp-server/cmd/terraform-mcp-server@latest

Use the main branch:

go install github.com/hashicorp/terraform-mcp-server/cmd/terraform-mcp-server@main
{
  "mcp": {
    "servers": {
      "terraform": {
        "command": "/path/to/terraform-mcp-server",
        "args": ["stdio"]
      }
    }
  }
}

Building the Docker Image locally

Before using the server, you need to build the Docker image locally:

  1. Clone the repository:
git clone https://github.com/hashicorp/terraform-mcp-server.git
cd terraform-mcp-server
  1. Build the Docker image:
make docker-build
  1. This will create a local Docker image that you can use in the following configuration.
# Run in stdio mode
docker run -i --rm terraform-mcp-server:dev

# Run in streamable-http mode
docker run -p 8080:8080 --rm -e TRANSPORT_MODE=streamable-http -e TRANSPORT_HOST=0.0.0.0 terraform-mcp-server:dev

Note: When running in Docker, you should set TRANSPORT_HOST=0.0.0.0 to allow connections from outside the container.

  1. (Optional) Test connection in http mode
# Test the connection
curl http://localhost:8080/health
  1. You can use it on your AI assistant as follow:
{
  "mcpServers": {
    "terraform": {
      "command": "docker",
      "args": [
        "run",
        "-i",
        "--rm",
        "terraform-mcp-server:dev"
      ]
    }
  }
}

Development

Prerequisites

  • Go (check file for specific version)
  • Docker (optional, for container builds)

Available Make Commands

CommandDescription
make buildBuild the binary
make testRun all tests
make test-e2eRun end-to-end tests
make docker-buildBuild Docker image
make run-httpRun HTTP server locally
make docker-run-httpRun HTTP server in Docker
make test-httpTest HTTP health endpoint
make cleanRemove build artifacts
make helpShow all available commands

Contributing

  1. Fork the repository
  2. Create your feature branch
  3. Make your changes
  4. Run tests
  5. Submit a pull request

License

This project is licensed under the terms of the MPL-2.0 open source license. Please refer to file for the full terms.

Security

For security issues, please contact security@hashicorp.com or follow our security policy.

Support

For bug reports and feature requests, please open an issue on GitHub.

For general questions and discussions, open a GitHub Discussion.