Terraform Mcp 服务器

什么是 Terraform MCP 服务器？

Terraform MCP 服务器是一个强大的工具，旨在通过为基础设施即代码（IaC）开发提供无缝集成和高级自动化能力来增强 Terraform 生态系统。它允许开发人员高效地管理和编排他们的基础设施，利用 Terraform 的能力来自动化云资源的配置和管理。

Terraform MCP 服务器的特点

• 无缝集成：Terraform MCP 服务器与现有的 Terraform 工作流平滑集成，使用户能够在不干扰的情况下利用他们当前的基础设施管理实践。
• 高级自动化：它提供高级自动化功能，简化管理复杂基础设施设置的过程，减少人工干预和潜在错误。
• 基础设施即代码（IaC）：支持 IaC 范式，允许用户使用代码定义他们的基础设施，这些代码可以进行版本控制、共享和重用。
• 可扩展性：该服务器旨在处理大规模部署，适合基础设施需求广泛的企业。
• 社区支持：作为 HashiCorp 生态系统的一部分，它受益于庞大的用户和贡献者社区，提供丰富的资源和支持。

如何使用 Terraform MCP 服务器

1. 安装：首先在您选择的环境中安装 Terraform MCP 服务器。请按照官方安装指南进行详细步骤。
2. 配置：配置服务器以连接到您现有的 Terraform 设置。这可能涉及设置身份验证和定义您的基础设施需求。
3. 定义基础设施：使用 Terraform 配置文件定义您的基础设施。指定所需的资源、其配置和任何依赖关系。
4. 部署：运行 Terraform 命令以部署您的基础设施。MCP 服务器将处理根据您的配置文件定义的资源的编排和管理。
5. 监控和管理：利用服务器的监控工具跟踪您基础设施的性能，并根据需要进行调整。

常见问题解答

Q1: Terraform MCP 服务器的主要目的是什么？

A1: Terraform MCP 服务器的主要目的是通过提供高级自动化和集成功能来增强 Terraform 生态系统，以管理基础设施即代码。

Q2: 我可以将 Terraform MCP 服务器与现有的 Terraform 项目一起使用吗？

A2: 是的，Terraform MCP 服务器旨在与现有的 Terraform 项目无缝集成，使您能够在不从头开始的情况下增强当前的工作流程。

Q3: Terraform MCP 服务器是否有社区支持？

A3: 当然！Terraform MCP 服务器是 HashiCorp 生态系统的一部分，拥有活跃的用户和贡献者社区，提供支持和资源。

Q4: Terraform MCP 服务器如何处理可扩展性？

A4: Terraform MCP 服务器旨在有效管理大规模部署，确保能够处理广泛的基础设施需求而不影响性能。

Q5: 使用 Terraform MCP 服务器的先决条件是什么？

A5: 用户应对 Terraform 和基础设施即代码原则有基本了解。熟悉云服务提供商及其 API 也会有所帮助。

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