Servidor Mcp de Terraform

¿Qué es el Servidor MCP de Terraform?

El ### Servidor MCP de Terraform es una herramienta poderosa diseñada para mejorar el ecosistema de Terraform al proporcionar integración fluida y capacidades avanzadas de automatización para el desarrollo de Infraestructura como Código (IaC). Permite a los desarrolladores gestionar y orquestar su infraestructura de manera eficiente, aprovechando las capacidades de Terraform para automatizar la provisión y gestión de recursos en la nube.

Características del Servidor MCP de Terraform

• Integración Fluida: El Servidor MCP de Terraform se integra sin problemas con los flujos de trabajo existentes de Terraform, permitiendo a los usuarios aprovechar sus prácticas actuales de gestión de infraestructura sin interrupciones.
• Automatización Avanzada: Proporciona características de automatización avanzadas que simplifican el proceso de gestión de configuraciones de infraestructura complejas, reduciendo la intervención manual y los errores potenciales.
• Infraestructura como Código (IaC): Soporta el paradigma IaC, permitiendo a los usuarios definir su infraestructura utilizando código, que puede ser versionado, compartido y reutilizado.
• Escalabilidad: El servidor está diseñado para manejar implementaciones a gran escala, lo que lo hace adecuado para empresas con necesidades de infraestructura extensas.
• Soporte Comunitario: Al ser parte del ecosistema de HashiCorp, se beneficia de una gran comunidad de usuarios y colaboradores, proporcionando una gran cantidad de recursos y apoyo.

Cómo Usar el Servidor MCP de Terraform

1. Instalación: Comienza instalando el Servidor MCP de Terraform en tu entorno preferido. Sigue la guía de instalación oficial para obtener pasos detallados.
2. Configuración: Configura el servidor para conectarse con tu configuración existente de Terraform. Esto puede implicar establecer autenticación y definir tus requisitos de infraestructura.
3. Definir Infraestructura: Utiliza archivos de configuración de Terraform para definir tu infraestructura. Especifica los recursos que necesitas, sus configuraciones y cualquier dependencia.
4. Desplegar: Ejecuta los comandos de Terraform para desplegar tu infraestructura. El Servidor MCP se encargará de la orquestación y gestión de los recursos según lo definido en tus archivos de configuración.
5. Monitorear y Gestionar: Utiliza las herramientas de monitoreo del servidor para realizar un seguimiento del rendimiento de tu infraestructura y hacer ajustes según sea necesario.

Preguntas Frecuentes

P1: ¿Cuál es el propósito principal del Servidor MCP de Terraform?

R1: El propósito principal del Servidor MCP de Terraform es mejorar el ecosistema de Terraform al proporcionar capacidades avanzadas de automatización e integración para gestionar infraestructura como código.

P2: ¿Puedo usar el Servidor MCP de Terraform con proyectos de Terraform existentes?

R2: Sí, el Servidor MCP de Terraform está diseñado para integrarse sin problemas con proyectos de Terraform existentes, permitiéndote mejorar tus flujos de trabajo actuales sin empezar desde cero.

P3: ¿Hay soporte comunitario disponible para el Servidor MCP de Terraform?

R3: ¡Absolutamente! El Servidor MCP de Terraform es parte del ecosistema de HashiCorp, que cuenta con una comunidad vibrante de usuarios y colaboradores que proporcionan apoyo y recursos.

P4: ¿Cómo maneja el Servidor MCP de Terraform la escalabilidad?

R4: El Servidor MCP de Terraform está construido para gestionar implementaciones a gran escala de manera efectiva, asegurando que pueda manejar necesidades de infraestructura extensas sin comprometer el rendimiento.

P5: ¿Cuáles son los requisitos previos para usar el Servidor MCP de Terraform?

R5: Los usuarios deben tener un conocimiento básico de Terraform y principios de Infraestructura como Código. La familiaridad con proveedores de servicios en la nube y sus API también puede ser beneficiosa.

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