JinDaGe - mcp-server-hcp-terraform MCP Details

article

README

🚀 mcp-server-hcp-terraform

本项目提供的MCP服务器，可与HashiCorp Terraform云/企业版API集成，助力用户轻松访问并搜索Terraform模块，获取模块详细信息。

🚀 快速开始

此项目提供一个可与HashiCorp Terraform云/企业版API集成的MCP服务器。借助MCP，您能够实现搜索Terraform模块、获取模块信息等功能。

✨ 主要特性

此MCP服务器具备以下实用功能：

搜索私有模块

可使用hcp_terraform_search_private_modules工具，在HashiCorp Terraform私有仓库中精准搜索模块。参数：

query：搜索查询条件。
provider（可选）：提供商过滤器（如aws、gcp、azure）。
limit（可选）：结果的最大数量（默认值为10）。

获取模块详情

利用hcp_terraform_get_module工具，可获取特定模块在HashiCorp Terraform仓库中的详细信息。参数：

module_name：模块名称。
provider：提供商（如aws、gcp、azure）。
registry_name（可选）：仓库名称（私有或公共，默认为私有）。
namespace（可选）：模块命名空间（未指定时使用组织名称）。

📦 安装指南

先决条件

需安装Python 3.13+版本。
拥有HashiCorp Terraform云/企业版账户。
准备好访问令牌。

环境变量

在使用前，请设置以下环境变量：

HCP_TERRAFORM_TOKEN：HashiCorp Terraform访问令牌（必需）。
HCP_TERRAFORM_ORG：HashiCorp Terraform组织名称（必需）。
HCP_TERRAFORM_BASE_URL：HashiCorp Terraform基础URL（可选，默认值为https://app.terraform.io）。

💻 使用示例

基础用法

以下是使用配置示例：

{
  "globalShortcut": "",
  "mcpServers": {
    "HCP Terraform": {
      "command": "uv",
      "args": [
        "run",
        "--with",
        "mcp[cli]",
        "mcp",
        "run",
        "path/to/mcp-server-hcp-terraform/server.py"
      ],
      "env": {
        "HCP_TERRAFORM_TOKEN": "paste_here",
        "HCP_TERRAFORM_ORG": "my_org"
      }
    }
  }
}

📄 许可证

本项目采用MIT许可证。

mcp-server-hcp-terraform