Server Mcp di Terraform

Cos'è il Server Terraform MCP?

Il ### Server Terraform MCP è uno strumento potente progettato per migliorare l'ecosistema Terraform fornendo integrazione fluida e capacità di automazione avanzate per lo sviluppo di Infrastructure as Code (IaC). Consente agli sviluppatori di gestire e orchestrare la propria infrastruttura in modo efficiente, sfruttando le capacità di Terraform per automatizzare il provisioning e la gestione delle risorse cloud.

Caratteristiche del Server Terraform MCP

• Integrazione Fluida: Il Server Terraform MCP si integra senza problemi con i flussi di lavoro Terraform esistenti, consentendo agli utenti di sfruttare le proprie pratiche di gestione dell'infrastruttura attuali senza interruzioni.
• Automazione Avanzata: Fornisce funzionalità di automazione avanzate che semplificano il processo di gestione di configurazioni infrastrutturali complesse, riducendo l'intervento manuale e i potenziali errori.
• Infrastructure as Code (IaC): Supporta il paradigma IaC, consentendo agli utenti di definire la propria infrastruttura utilizzando codice, che può essere versionato, condiviso e riutilizzato.
• Scalabilità: Il server è progettato per gestire distribuzioni su larga scala, rendendolo adatto per le imprese con esigenze infrastrutturali estese.
• Supporto della Comunità: Essendo parte dell'ecosistema HashiCorp, beneficia di una grande comunità di utenti e contributori, fornendo una ricchezza di risorse e supporto.

Come Utilizzare il Server Terraform MCP

1. Installazione: Inizia installando il Server Terraform MCP nel tuo ambiente preferito. Segui la guida all'installazione ufficiale per i passaggi dettagliati.
2. Configurazione: Configura il server per connetterti al tuo setup Terraform esistente. Questo potrebbe comportare la configurazione dell'autenticazione e la definizione dei requisiti infrastrutturali.
3. Definire l'Infrastruttura: Utilizza i file di configurazione di Terraform per definire la tua infrastruttura. Specifica le risorse di cui hai bisogno, le loro configurazioni e eventuali dipendenze.
4. Distribuzione: Esegui i comandi Terraform per distribuire la tua infrastruttura. Il Server MCP gestirà l'orchestrazione e la gestione delle risorse come definito nei tuoi file di configurazione.
5. Monitorare e Gestire: Utilizza gli strumenti di monitoraggio del server per tenere traccia delle prestazioni della tua infrastruttura e apportare modifiche se necessario.

Domande Frequenti

D1: Qual è lo scopo principale del Server Terraform MCP?

R1: Lo scopo principale del Server Terraform MCP è migliorare l'ecosistema Terraform fornendo capacità avanzate di automazione e integrazione per la gestione dell'infrastruttura come codice.

D2: Posso utilizzare il Server Terraform MCP con progetti Terraform esistenti?

R2: Sì, il Server Terraform MCP è progettato per integrarsi senza problemi con progetti Terraform esistenti, consentendoti di migliorare i tuoi flussi di lavoro attuali senza dover ricominciare da zero.

D3: È disponibile supporto della comunità per il Server Terraform MCP?

R3: Assolutamente! Il Server Terraform MCP è parte dell'ecosistema HashiCorp, che ha una comunità vivace di utenti e contributori che forniscono supporto e risorse.

D4: Come gestisce il Server Terraform MCP la scalabilità?

R4: Il Server Terraform MCP è costruito per gestire efficacemente distribuzioni su larga scala, assicurando che possa affrontare esigenze infrastrutturali estese senza compromettere le prestazioni.

D5: Quali sono i requisiti per utilizzare il Server Terraform MCP?

R5: Gli utenti dovrebbero avere una comprensione di base di Terraform e dei principi di Infrastructure as Code. Familiarità con i fornitori di servizi cloud e le loro API può essere anche utile.

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