Atru/mcp server 1.0 ga#2566
Open
trujillo-adam wants to merge 13 commits into
Open
Conversation
Contributor
Vercel Previews Deployed
|
Contributor
Broken Link CheckerThis PR contains broken links, but won't be blocked. Use this report to improve content quality: Quick Actions
Need Help?
Internal LinksExternal LinksSummary
Errors per inputErrors in content/terraform-mcp-server/v1.0.x/docs/mcp-server/deploy/local.mdx
Redirects per inputRedirects in content/terraform-mcp-server/v1.0.x/docs/mcp-server/deploy/local.mdx
|
mattschouten
reviewed
Jun 3, 2026
Contributor
mattschouten
left a comment
mattschouten
left a comment
There was a problem hiding this comment.
Partial review in the time I had
|
|
||
| - **Hosting**: We recommend running the MCP Server locally at `127.0.0.1` through the STDIO or HTTP Streamable transport protocol to limit publicly exposing your Terraform environment. The default transport is set to STDIO. If you host the service remotely, we recommend implementing additional security controls at the application and network layers. | ||
| - **CORS**: By default, Terraform MCP server runs in `strict` CORS (cross-origin request) mode and the allowed origins are empty. As a result, all cross-origin requests are blocked unless the server is explicitly configured to allow them. Exercise caution when you need to change allowed origins list. | ||
| - **Terraform authentication**: The `TFE_SKIP_VERIFY` option is enabled by default. We recommend keeping the option enabled so that communication with your Terraform environment is encrypted. We also recommend limiting the permissions of the `TFE_TOKEN` used to authenticate as described in the Terraform documentation. Refer to [API tokens](/terraform/cloud-docs/users-teams-organizations/api-tokens) for more information. |
Contributor
There was a problem hiding this comment.
I'm a little confused here on the TFE_SKIP_VERIFY option. The paragraph says it's enabled by default (good!) and that we recommend keeping it enabled (good!) - is there a reason someone might disable it? I think my confusion is basically "why are we mentioning it?"
Contributor
Author
There was a problem hiding this comment.
Maybe for testing purposes? @vravind1 - Do you have any insight about this item? I can see mentioning it if there is a case for reminding users who set this to true for some reason to switch it back to false. But why would you even disable encryption in the first place?
Member
There was a problem hiding this comment.
yes for testing and local usage if needed
|
|
||
| This topic describes how to deploy the Terraform Model Context Protocol (MCP) server into a remote environment so that you can centrally manage an instance of the server. This ensures that team members always have access to the same set of tools and that your organization can uniformly enforce security policies for accessing your registry and other platform resources. | ||
|
|
||
| For information about deploying the server locally, refer to [Deploy Terraform MCP server locallly](/terraform/mcp-server/deploy/local). |
Contributor
There was a problem hiding this comment.
Suggested change
| For information about deploying the server locally, refer to [Deploy Terraform MCP server locallly](/terraform/mcp-server/deploy/local). | |
| For information about deploying the server locally, refer to [Deploy Terraform MCP server locally](/terraform/mcp-server/deploy/local). |
|
|
||
| ### Docker container | ||
|
|
||
| To use the Terraform HCP server Docker image, you must have Docker Engine v20.10.21+ or Docker Desktop v4.14.0+ installed on the local machine. Refer to the [Docker documentation](https://docs.docker.com/desktop) for installation instructions. |
Contributor
There was a problem hiding this comment.
Suggested change
| To use the Terraform HCP server Docker image, you must have Docker Engine v20.10.21+ or Docker Desktop v4.14.0+ installed on the local machine. Refer to the [Docker documentation](https://docs.docker.com/desktop) for installation instructions. | |
| To use the Terraform MCP server Docker image, you must have Docker Engine v20.10.21+ or Docker Desktop v4.14.0+ installed on the target machine. Refer to the [Docker documentation](https://docs.docker.com/desktop) for installation instructions. |
vravind1
previously requested changes
Jun 4, 2026
|
|
||
| - **Hosting**: We recommend running the MCP Server locally at `127.0.0.1` through the STDIO or HTTP Streamable transport protocol to limit publicly exposing your Terraform environment. The default transport is set to STDIO. If you host the service remotely, we recommend implementing additional security controls at the application and network layers. | ||
| - **CORS**: By default, Terraform MCP server runs in `strict` CORS (cross-origin request) mode and the allowed origins are empty. As a result, all cross-origin requests are blocked unless the server is explicitly configured to allow them. Exercise caution when you need to change allowed origins list. | ||
| - **Terraform authentication**: The `TFE_SKIP_VERIFY` option is enabled by default. We recommend keeping the option enabled so that communication with your Terraform environment is encrypted. We also recommend limiting the permissions of the `TFE_TOKEN` used to authenticate as described in the Terraform documentation. Refer to [API tokens](/terraform/cloud-docs/users-teams-organizations/api-tokens) for more information. |
Contributor
There was a problem hiding this comment.
Also, the right var name is TFE_SKIP_TLS_VERIFY
Co-authored-by: Matt Schouten <matt.schouten@gmail.com>
trujillo-adam
commented
Jun 4, 2026
Contributor
Author
trujillo-adam
left a comment
trujillo-adam
left a comment
There was a problem hiding this comment.
@mattschouten @vravind1 @Shweta-Deshpande - I applied the feedback and responded to your comments with a few follow up questions.
|
|
||
| - **Hosting**: We recommend running the MCP Server locally at `127.0.0.1` through the STDIO or HTTP Streamable transport protocol to limit publicly exposing your Terraform environment. The default transport is set to STDIO. If you host the service remotely, we recommend implementing additional security controls at the application and network layers. | ||
| - **CORS**: By default, Terraform MCP server runs in `strict` CORS (cross-origin request) mode and the allowed origins are empty. As a result, all cross-origin requests are blocked unless the server is explicitly configured to allow them. Exercise caution when you need to change allowed origins list. | ||
| - **Terraform authentication**: The `TFE_SKIP_VERIFY` option is enabled by default. We recommend keeping the option enabled so that communication with your Terraform environment is encrypted. We also recommend limiting the permissions of the `TFE_TOKEN` used to authenticate as described in the Terraform documentation. Refer to [API tokens](/terraform/cloud-docs/users-teams-organizations/api-tokens) for more information. |
Contributor
Author
There was a problem hiding this comment.
Maybe for testing purposes? @vravind1 - Do you have any insight about this item? I can see mentioning it if there is a case for reminding users who set this to true for some reason to switch it back to false. But why would you even disable encryption in the first place?
|
|
||
| </Tabs> | ||
|
|
||
| ### Run without authentication |
Contributor
Author
There was a problem hiding this comment.
@vravind1 @Shweta-Deshpande - correct me if I'm wrong, but I think this is the wrong way to present this. Instead of auth vs w/o-auth, this should be connect to your registry or the public registry, right?
Co-authored-by: trujillo-adam <47586768+trujillo-adam@users.noreply.github.com>
mattschouten
reviewed
Jun 5, 2026
Contributor
mattschouten
left a comment
mattschouten
left a comment
There was a problem hiding this comment.
A few more observations as I went through again.
|
|
||
| ## Threat model | ||
|
|
||
| You should be aware of the following potential threats to the Terraform MCP server. |
Contributor
There was a problem hiding this comment.
It occurs to me that some of the token stuff that was talked about in comments/discussion on the deployment might be useful here. Especially if there's a remote MCP that's given a token...there's possibly data exfiltration or workspace-related mischief a user could do if they got access to a poorly secured MCP.
Could be a ticket for future changes to this doc.
jrhouston
reviewed
Jun 5, 2026
jrhouston
reviewed
Jun 5, 2026
BrianMMcClain
approved these changes
Jun 5, 2026
|
|
||
| - **Hosting**: We recommend running the MCP server locally at `127.0.0.1` through the STDIO or HTTP Streamable transport protocol to limit publicly exposing your Terraform environment. The default transport is set to STDIO. If you host the service remotely, we recommend implementing additional security controls at the application and network layers. | ||
| - **CORS**: By default, Terraform MCP server runs in `strict` CORS (cross-origin request) mode and the allowed origins are empty. As a result, all cross-origin requests are blocked unless the server is explicitly configured to allow them. Exercise caution when changing the allowed origins list. | ||
| - **Terraform authentication**: The `TFE_SKIP_TLS_VERIFY` option is set to `false` by default so that communication with your Terraform environment is encrypted. If you temporarily set this option to `true` for testing or other use cases, we strongly recommend resetting to `false` to ensure that encryption is enabled. We also recommend limiting the permissions of the `TFE_TOKEN` used to authenticate as described in the Terraform documentation. Refer to [API tokens](/terraform/cloud-docs/users-teams-organizations/api-tokens) for more information. |
Contributor
There was a problem hiding this comment.
Does skipping verification actually disable encryption, or does it just continue with operations even if the certificate isn't valid (self-signed, expired, etc)? Agree w/ the advice but just want to make sure we're being accurate.
| | `TFE_TOKEN` | Terraform Enterprise API token | `""` (empty) | | ||
| | `TFE_SKIP_TLS_VERIFY` | Skip HCP Terraform or Terraform Enterprise TLS verification | `false` | | ||
| | `TRANSPORT_MODE` | Set to `streamable-http` to enable HTTP transport (legacy `http`) | `stdio` | | ||
| | `TRANSPORT_HOST` | Host to bind the HTTP server | `127.0.0.1` | |
Contributor
There was a problem hiding this comment.
Suggested change
| | `TRANSPORT_HOST` | Host to bind the HTTP server | `127.0.0.1` | | |
| | `TRANSPORT_HOST` | Host to bind the HTTP server. Set to `0.0.0.0` to bind to all interfaces | `127.0.0.1` | |
What do you think about this clarification? I don't believe this is called out anywhere else in the docs
| - `plan_only`: Creates a plan without applying | ||
| - `allow_empty_apply`: Allows applying when no changes are detected | ||
|
|
||
| When `ENABLE_TF_OPERATIONS` is set to `true`, the following additional options become available: |
Contributor
There was a problem hiding this comment.
Suggested change
| When `ENABLE_TF_OPERATIONS` is set to `true`, the following additional options become available: | |
| When you set `ENABLE_TF_OPERATIONS` to `true`, the following additional options become available: |
|
|
||
| ## Telemetry metrics | ||
|
|
||
| When enabled, Terraform MCP server collects the following metrics: |
Contributor
There was a problem hiding this comment.
Suggested change
| When enabled, Terraform MCP server collects the following metrics: | |
| When enabled, the Terraform MCP server collects the following metrics: |
|
|
||
| | Type | Emitted metrics | Notes | | ||
| | --- | --- | --- | | ||
| | Standard HTTP server metrics | <ul><li>`http.server.request.body.size`</li><li>`http.server.response.body.size`</li><li> `http.server.request.duration`</li></ul> | The server wraps the HTTP mux with `otelhttp.NewHandler(...)` to emit the metrics. | |
Contributor
There was a problem hiding this comment.
The server wraps the HTTP mux with
otelhttp.NewHandler(...)to emit the metrics.
This is a little outside my wheelhouse, but is this relevant to the user? IMO this reads more like a note that someone working on the server code itself would be concerned with. Would something like "The server emits these metrics using OpenTelemetry" be more relevant to the end user?
Contributor
Author
There was a problem hiding this comment.
Yeah, I'm not sure how in the weeds we need to get, so we've kept this as is. Maybe it's helpful for people making custom integrations.
Comment on lines
+48
to
+49
| - **Foundational model**: Concerns related to the underlying AI models, training data, and inherent vulnerabilities. | ||
| - **Infrastructure deployment**: Concerns related to the security of infrastructure, network and software environments configuration and deployment through the output of the model should always be reviewed prior to any change application. |
Contributor
There was a problem hiding this comment.
WTF formatting, we have a couple instances in the docs (I believe the deployment docs) where we don't bold these leading phrases. Might be worth a quick check to make this consistent if we have time before publishing.
BrianMMcClain
approved these changes
Jun 5, 2026
trujillo-adam
commented
Jun 5, 2026
trujillo-adam
commented
Jun 5, 2026
Co-authored-by: Brian McClain <brianmmcclain@gmail.com> Co-authored-by: trujillo-adam <47586768+trujillo-adam@users.noreply.github.com>
Co-authored-by: trujillo-adam <47586768+trujillo-adam@users.noreply.github.com>
Co-authored-by: Matt Schouten <matt.schouten@gmail.com> Co-authored-by: Brian McClain <brianmmcclain@gmail.com> Co-authored-by: trujillo-adam <47586768+trujillo-adam@users.noreply.github.com>
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
7 participants
Add this suggestion to a batch that can be applied as a single commit.This suggestion is invalid because no changes were made to the code.Suggestions cannot be applied while the pull request is closed.Suggestions cannot be applied while viewing a subset of changes.Only one suggestion per line can be applied in a batch.Add this suggestion to a batch that can be applied as a single commit.Applying suggestions on deleted lines is not supported.You must change the existing code in this line in order to create a valid suggestion.Outdated suggestions cannot be applied.This suggestion has been applied or marked resolved.Suggestions cannot be applied from pending reviews.Suggestions cannot be applied on multi-line comments.Suggestions cannot be applied while the pull request is queued to merge.Suggestion cannot be applied right now. Please check back later.
This PR increments the version for the Terraform MCP server documentation and creates separate topics for local and remote server deployments.