Serveur Mcp Terraform

Qu'est-ce que le serveur Terraform MCP ?

Le ### serveur Terraform MCP est un outil puissant conçu pour améliorer l'écosystème Terraform en offrant une intégration transparente et des capacités d'automatisation avancées pour le développement d'Infrastructure as Code (IaC). Il permet aux développeurs de gérer et d'orchestrer leur infrastructure de manière efficace, en tirant parti des capacités de Terraform pour automatiser la provision et la gestion des ressources cloud.

Fonctionnalités du serveur Terraform MCP

• Intégration transparente : Le serveur Terraform MCP s'intègre parfaitement aux flux de travail Terraform existants, permettant aux utilisateurs de tirer parti de leurs pratiques de gestion d'infrastructure actuelles sans interruption.
• Automatisation avancée : Il offre des fonctionnalités d'automatisation avancées qui simplifient le processus de gestion des configurations d'infrastructure complexes, réduisant ainsi l'intervention manuelle et les erreurs potentielles.
• Infrastructure as Code (IaC) : Prend en charge le paradigme IaC, permettant aux utilisateurs de définir leur infrastructure à l'aide de code, qui peut être versionné, partagé et réutilisé.
• Scalabilité : Le serveur est conçu pour gérer des déploiements à grande échelle, ce qui le rend adapté aux entreprises ayant des besoins d'infrastructure étendus.
• Support communautaire : Faisant partie de l'écosystème HashiCorp, il bénéficie d'une grande communauté d'utilisateurs et de contributeurs, fournissant une richesse de ressources et de soutien.

Comment utiliser le serveur Terraform MCP

1. Installation : Commencez par installer le serveur Terraform MCP sur votre environnement préféré. Suivez le guide d'installation officiel pour des étapes détaillées.
2. Configuration : Configurez le serveur pour se connecter à votre configuration Terraform existante. Cela peut impliquer la mise en place de l'authentification et la définition de vos exigences d'infrastructure.
3. Définir l'infrastructure : Utilisez des fichiers de configuration Terraform pour définir votre infrastructure. Spécifiez les ressources dont vous avez besoin, leurs configurations et toutes les dépendances.
4. Déployer : Exécutez les commandes Terraform pour déployer votre infrastructure. Le serveur MCP gérera l'orchestration et la gestion des ressources telles que définies dans vos fichiers de configuration.
5. Surveiller et gérer : Utilisez les outils de surveillance du serveur pour suivre les performances de votre infrastructure et apporter des ajustements si nécessaire.

Questions Fréquemment Posées

Q1 : Quel est le but principal du serveur Terraform MCP ?

A1 : Le but principal du serveur Terraform MCP est d'améliorer l'écosystème Terraform en fournissant des capacités d'automatisation et d'intégration avancées pour la gestion de l'infrastructure en tant que code.

Q2 : Puis-je utiliser le serveur Terraform MCP avec des projets Terraform existants ?

A2 : Oui, le serveur Terraform MCP est conçu pour s'intégrer parfaitement aux projets Terraform existants, vous permettant d'améliorer vos flux de travail actuels sans repartir de zéro.

Q3 : Un support communautaire est-il disponible pour le serveur Terraform MCP ?

A3 : Absolument ! Le serveur Terraform MCP fait partie de l'écosystème HashiCorp, qui dispose d'une communauté dynamique d'utilisateurs et de contributeurs fournissant soutien et ressources.

Q4 : Comment le serveur Terraform MCP gère-t-il la scalabilité ?

A4 : Le serveur Terraform MCP est conçu pour gérer efficacement des déploiements à grande échelle, garantissant qu'il peut répondre à des besoins d'infrastructure étendus sans compromettre les performances.

Q5 : Quelles sont les conditions préalables à l'utilisation du serveur Terraform MCP ?

A5 : Les utilisateurs doivent avoir une compréhension de base de Terraform et des principes d'Infrastructure as Code. Une familiarité avec les fournisseurs de services cloud et leurs API peut également être bénéfique.

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