Servidor Mcp do Terraform

O que é o Servidor Terraform MCP?

O ### Servidor Terraform MCP é uma ferramenta poderosa projetada para aprimorar o ecossistema Terraform, proporcionando integração perfeita e capacidades avançadas de automação para o desenvolvimento de Infraestrutura como Código (IaC). Ele permite que os desenvolvedores gerenciem e orquestrem sua infraestrutura de forma eficiente, aproveitando as capacidades do Terraform para automatizar o provisionamento e a gestão de recursos em nuvem.

Recursos do Servidor Terraform MCP

• Integração Sem Costura: O Servidor Terraform MCP se integra suavemente aos fluxos de trabalho existentes do Terraform, permitindo que os usuários aproveitem suas práticas atuais de gerenciamento de infraestrutura sem interrupções.
• Automação Avançada: Ele fornece recursos de automação avançada que simplificam o processo de gerenciamento de configurações de infraestrutura complexas, reduzindo a intervenção manual e potenciais erros.
• Infraestrutura como Código (IaC): Suporta o paradigma IaC, permitindo que os usuários definam sua infraestrutura usando código, que pode ser versionado, compartilhado e reutilizado.
• Escalabilidade: O servidor é projetado para lidar com implantações em larga escala, tornando-o adequado para empresas com necessidades extensas de infraestrutura.
• Suporte da Comunidade: Sendo parte do ecossistema HashiCorp, ele se beneficia de uma grande comunidade de usuários e colaboradores, proporcionando uma riqueza de recursos e suporte.

Como Usar o Servidor Terraform MCP

1. Instalação: Comece instalando o Servidor Terraform MCP em seu ambiente preferido. Siga o guia de instalação oficial para etapas detalhadas.
2. Configuração: Configure o servidor para se conectar ao seu setup existente do Terraform. Isso pode envolver a configuração de autenticação e a definição de seus requisitos de infraestrutura.
3. Definir Infraestrutura: Use arquivos de configuração do Terraform para definir sua infraestrutura. Especifique os recursos que você precisa, suas configurações e quaisquer dependências.
4. Implantar: Execute os comandos do Terraform para implantar sua infraestrutura. O Servidor MCP cuidará da orquestração e gestão dos recursos conforme definido em seus arquivos de configuração.
5. Monitorar e Gerenciar: Utilize as ferramentas de monitoramento do servidor para acompanhar o desempenho da sua infraestrutura e fazer ajustes conforme necessário.

Perguntas Frequentes

Q1: Qual é o principal objetivo do Servidor Terraform MCP?

A1: O principal objetivo do Servidor Terraform MCP é aprimorar o ecossistema Terraform, fornecendo capacidades avançadas de automação e integração para gerenciar infraestrutura como código.

Q2: Posso usar o Servidor Terraform MCP com projetos Terraform existentes?

A2: Sim, o Servidor Terraform MCP é projetado para se integrar perfeitamente a projetos Terraform existentes, permitindo que você melhore seus fluxos de trabalho atuais sem começar do zero.

Q3: Existe suporte da comunidade disponível para o Servidor Terraform MCP?

A3: Absolutamente! O Servidor Terraform MCP faz parte do ecossistema HashiCorp, que possui uma comunidade vibrante de usuários e colaboradores que fornecem suporte e recursos.

Q4: Como o Servidor Terraform MCP lida com escalabilidade?

A4: O Servidor Terraform MCP é construído para gerenciar implantações em larga escala de forma eficaz, garantindo que possa lidar com necessidades extensas de infraestrutura sem comprometer o desempenho.

Q5: Quais são os pré-requisitos para usar o Servidor Terraform MCP?

A5: Os usuários devem ter uma compreensão básica do Terraform e dos princípios de Infraestrutura como Código. Familiaridade com provedores de serviços em nuvem e suas APIs também pode ser benéfica.

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