Terraform MCP Server
The Terraform MCP Server is a Model Context Protocol (MCP)server that provides seamless integration with Terraform Registry APIs, enabling advancedautomation and interaction capabilities for Infrastructure as Code (IaC) development.
Use Cases
- Automating Terraform provider and module discovery
- Extracting and analyzing data from Terraform Registry
- Getting detailed information about provider resources and data sources
- Exploring and understanding Terraform modules
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
- To run the server in a container, you will need to have Docker installed.
- Once Docker is installed, you will need to ensure Docker is running.
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"
]
}
}
}
More about using MCP server tools in Claude Desktop user documentation.
Usage with Claude Desktop
{
"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. |
Build from source
If you don't have Docker, you can use make build
to build the binary directly from source code. You should configure your server to use the built executable as its command
.
- Clone the repository:
git clone https://github.com/hashicorp/terraform-mcp-server.git
cd terraform-mcp-server
- Build the binary:
make build
{
"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:
- Clone the repository:
git clone https://github.com/hashicorp/terraform-mcp-server.git
cd terraform-mcp-server
- Build the Docker image:
make docker-build
This will create a local Docker image that you can use in the following configuration.
{
"servers": {
"terraform": {
"command": "docker",
"args": [
"run",
"-i",
"--rm",
"terraform-mcp-server"
]
}
}
}
Development
Prerequisites
- Go (check go.mod file for specific version)
- Docker (optional, for container builds)
Running Tests
# Run all tests
make test
# Run e2e tests
make test-e2e
Available Make Commands
make build # Build the binary
make test # Run all tests
make test-e2e # Run end-to-end tests
make clean # Remove build artifacts
make deps # Download dependencies
make docker-build # Build docker image
Contributing
- Fork the repository
- Create your feature branch
- Make your changes
- Run tests
- 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 [email protected] 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.