Terraform Mcp Server

Was ist der Terraform MCP Server?

Der ### Terraform MCP Server ist ein leistungsstarkes Tool, das entwickelt wurde, um das Terraform-Ökosystem zu verbessern, indem es nahtlose Integration und fortschrittliche Automatisierungsfunktionen für die Entwicklung von Infrastructure as Code (IaC) bereitstellt. Es ermöglicht Entwicklern, ihre Infrastruktur effizient zu verwalten und zu orchestrieren, indem es die Fähigkeiten von Terraform nutzt, um die Bereitstellung und Verwaltung von Cloud-Ressourcen zu automatisieren.

Funktionen des Terraform MCP Servers

• Nahtlose Integration: Der Terraform MCP Server integriert sich reibungslos in bestehende Terraform-Workflows und ermöglicht es den Benutzern, ihre aktuellen Infrastrukturmanagementpraktiken ohne Unterbrechung zu nutzen.
• Fortgeschrittene Automatisierung: Er bietet fortschrittliche Automatisierungsfunktionen, die den Prozess der Verwaltung komplexer Infrastruktur-Setups vereinfachen, manuelle Eingriffe und potenzielle Fehler reduzieren.
• Infrastructure as Code (IaC): Unterstützt das IaC-Paradigma, das es Benutzern ermöglicht, ihre Infrastruktur mit Code zu definieren, der versioniert, geteilt und wiederverwendet werden kann.
• Skalierbarkeit: Der Server ist so konzipiert, dass er großangelegte Bereitstellungen bewältigen kann, was ihn für Unternehmen mit umfangreichen Infrastrukturbedürfnissen geeignet macht.
• Community-Support: Als Teil des HashiCorp-Ökosystems profitiert er von einer großen Gemeinschaft von Benutzern und Mitwirkenden, die eine Fülle von Ressourcen und Unterstützung bieten.

So verwenden Sie den Terraform MCP Server

1. Installation: Beginnen Sie mit der Installation des Terraform MCP Servers in Ihrer bevorzugten Umgebung. Befolgen Sie die offizielle Installationsanleitung für detaillierte Schritte.
2. Konfiguration: Konfigurieren Sie den Server, um sich mit Ihrem bestehenden Terraform-Setup zu verbinden. Dies kann die Einrichtung von Authentifizierung und die Definition Ihrer Infrastrukturanforderungen umfassen.
3. Infrastruktur definieren: Verwenden Sie Terraform-Konfigurationsdateien, um Ihre Infrastruktur zu definieren. Geben Sie die benötigten Ressourcen, deren Konfigurationen und alle Abhängigkeiten an.
4. Bereitstellen: Führen Sie die Terraform-Befehle aus, um Ihre Infrastruktur bereitzustellen. Der MCP Server kümmert sich um die Orchestrierung und Verwaltung der Ressourcen, wie in Ihren Konfigurationsdateien definiert.
5. Überwachen und Verwalten: Nutzen Sie die Überwachungstools des Servers, um die Leistung Ihrer Infrastruktur im Auge zu behalten und bei Bedarf Anpassungen vorzunehmen.

Häufig gestellte Fragen

F1: Was ist der Hauptzweck des Terraform MCP Servers?

A1: Der Hauptzweck des Terraform MCP Servers besteht darin, das Terraform-Ökosystem zu verbessern, indem er fortschrittliche Automatisierungs- und Integrationsfunktionen für das Management von Infrastructure as Code bereitstellt.

F2: Kann ich den Terraform MCP Server mit bestehenden Terraform-Projekten verwenden?

A2: Ja, der Terraform MCP Server ist so konzipiert, dass er nahtlos mit bestehenden Terraform-Projekten integriert werden kann, sodass Sie Ihre aktuellen Workflows verbessern können, ohne von vorne beginnen zu müssen.

F3: Gibt es Community-Support für den Terraform MCP Server?

A3: Absolut! Der Terraform MCP Server ist Teil des HashiCorp-Ökosystems, das eine lebendige Gemeinschaft von Benutzern und Mitwirkenden hat, die Unterstützung und Ressourcen bereitstellen.

F4: Wie geht der Terraform MCP Server mit Skalierbarkeit um?

A4: Der Terraform MCP Server ist darauf ausgelegt, großangelegte Bereitstellungen effektiv zu verwalten, sodass er umfangreiche Infrastrukturbedürfnisse ohne Leistungseinbußen bewältigen kann.

F5: Was sind die Voraussetzungen für die Verwendung des Terraform MCP Servers?

A5: Benutzer sollten ein grundlegendes Verständnis von Terraform und den Prinzipien von Infrastructure as Code haben. Vertrautheit mit Cloud-Service-Anbietern und deren APIs kann ebenfalls von Vorteil sein.

<img src="public/images/Terraform-LogoMark_onDark.svg" width="30" align="left" style="margin-right: 12px;"/> 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.

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 MODE=http or PORT=8080 to enable

Environment Variables:

| Variable | Description | Default | |-|-|| | MODE | Set to http to enable HTTP transport | stdio | | PORT | HTTP server port | 8080 |

Command Line Options

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

### HTTP mode
terraform-mcp-server http [--port 8080] [--host 0.0.0.0] [--log-file /path/to/log]

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:

| Toolset | Tool | Description | |-||-| | providers | resolveProviderDocID | Queries the Terraform Registry to find and list available documentation for a specific provider using the specified serviceSlug. Returns a list of provider document IDs with their titles and categories for resources, data sources, functions, or guides. | | providers | getProviderDocs | Fetches the complete documentation content for a specific provider resource, data source, or function using a document ID obtained from the resolveProviderDocID tool. Returns the raw documentation in markdown format. | | modules | searchModules | Searches the Terraform Registry for modules based on specified moduleQuery with pagination. Returns a list of module IDs with their names, descriptions, download counts, verification status, and publish dates | | modules | moduleDetails | Retrieves detailed documentation for a module using a module ID obtained from the searchModules tool including inputs, outputs, configuration, submodules, and examples. | | policies | searchPolicies | Queries the Terraform Registry to find and list the appropriate Sentinel Policy based on the provided query policyQuery. Returns a list of matching policies with terraformPolicyIDs with their name, title and download counts. | | policies | policyDetails | Retrieves detailed documentation for a policy set using a terraformPolicyID obtained from the searchPolicies tool including policy readme and implementation details. |

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

2. Build the Docker image:

make docker-build

3. 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 http mode
docker run -p 8080:8080 --rm -e MODE=http terraform-mcp-server:dev

4. (Optional) Test connection in http mode

### Test the connection
curl http://localhost:8080/health

5. 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 go.mod file for specific version)
• Docker (optional, for container builds)

Available Make Commands

| Command | Description | ||-| | make build | Build the binary | | make test | Run all tests | | make test-e2e | Run end-to-end tests | | make docker-build | Build Docker image | | make run-http | Run HTTP server locally | | make docker-run-http | Run HTTP server in Docker | | make test-http | Test HTTP health endpoint | | make clean | Remove build artifacts | | make help | Show 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 LICENSE 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.