- Notifications
You must be signed in to change notification settings - Fork54
The Terraform MCP Server provides seamless integration with Terraform ecosystem, enabling advanced automation and interaction capabilities for Infrastructure as Code (IaC) development.
License
hashicorp/terraform-mcp-server
Folders and files
Name | Name | Last commit message | Last commit date | |
---|---|---|---|---|
Repository files navigation
The Terraform MCP Server is aModel Context Protocol (MCP)server that provides seamless integration with Terraform Registry APIs, enabling advancedautomation and interaction capabilities for Infrastructure as Code (IaC) development.
- 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 shouldthoroughly review all outputs/recommendations to ensure they align with their organization'ssecurity best practices,cost-efficiency goals, andcompliance requirements before implementation.
- To run the server in a container, you will need to haveDocker installed.
- Once Docker is installed, you will need to ensure Docker is running.
Add the following JSON block to your User Settings (JSON) file in VS Code. You can do this by pressingCtrl + Shift + P
and typingPreferences: Open User Settings (JSON)
.
More about using MCP server tools in VS Code'sagent 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 Desktopuser documentation.
{"mcpServers": {"terraform": {"command":"docker","args": ["run","-i","--rm","hashicorp/terraform-mcp-server" ] } }}
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 specifiedserviceSlug . 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 theresolveProviderDocID tool. Returns the raw documentation in markdown format. |
modules | searchModules | Searches the Terraform Registry for modules based on specifiedmoduleQuery 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 thesearchModules tool including inputs, outputs, configuration, submodules, and examples. |
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"] } } }}
Before using the server, you need to build the Docker image locally:
- Clone the repository:
git clone https://github.com/hashicorp/terraform-mcp-server.gitcd 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" ] } }}
- Go (checkgo.mod file for specific version)
- Docker (optional, for container builds)
# Run all testsmaketest# Run e2e testsmake test-e2e
make build# Build the binarymaketest# Run all testsmake test-e2e# Run end-to-end testsmake clean# Remove build artifactsmake deps# Download dependenciesmake docker-build# Build docker image
- Fork the repository
- Create your feature branch
- Make your changes
- Run tests
- Submit a pull request
This project is licensed under the terms of the MPL-2.0 open source license. Please refer toLICENSE file for the full terms.
For security issues, please contactsecurity@hashicorp.com or follow oursecurity policy.
For bug reports and feature requests, please open an issue on GitHub.
For general questions and discussions, open a GitHub Discussion.
About
The Terraform MCP Server provides seamless integration with Terraform ecosystem, enabling advanced automation and interaction capabilities for Infrastructure as Code (IaC) development.
Resources
License
Code of conduct
Security policy
Uh oh!
There was an error while loading.Please reload this page.
Stars
Watchers
Forks
Uh oh!
There was an error while loading.Please reload this page.