关键词

TerraformRegistryProviderResourceModule基础设施即代码IaCAI Agent开发辅助信息查询

使用说明

项目简介

Terraform Registry MCP Server 是一个基于 Model Context Protocol (MCP) 构建的服务器，旨在为 AI Agent 提供与 Terraform Registry API 交互的能力。通过此服务器，AI Agent 可以查询 Terraform Provider 的详细信息、Resource 的使用示例、Module 的元数据等，从而更好地理解和使用 Terraform。

主要功能点

  • Provider 查询: 根据名称查找 Terraform Provider 的详细信息，包括最新版本和版本数量。
  • Resource 使用示例: 获取 Terraform Resource 的使用示例代码以及相关的 Resource 信息。
  • Module 推荐: 根据关键词搜索和推荐相关的 Terraform Module。
  • Data Source 查询: 列出指定 Terraform Provider 的所有可用 Data Source。
  • Resource 参数详情: 获取 Terraform Resource 的参数详细信息，包括必需和可选属性、嵌套块及其描述。
  • Module 详情: 获取 Terraform Module 的详细元数据，包括版本、输入、输出和依赖关系。

安装步骤

  1. 安装 Node.js 和 npm: 确保你的系统中已安装 Node.js 和 npm (Node 包管理器)。
  2. 下载仓库代码: 从 GitHub 仓库 https://github.com/thrashr888/terraform-mcp-server 下载代码到本地。
  3. 进入项目目录: 使用命令行工具（如 Terminal 或 Cmd）进入下载的仓库目录。
  4. 安装依赖: 在项目根目录下运行命令 'npm install'，安装项目所需的依赖包。
  5. 启动服务器: 运行命令 'npm start' 启动 MCP 服务器。服务器将通过标准输入/输出 (stdio) 进行通信。

服务器配置

要将 Terraform Registry MCP Server 集成到 MCP 客户端（例如 Cursor 或 Claude Desktop），你需要配置 MCP 服务器的启动命令。以下是针对不同 MCP 客户端的配置示例，请复制以下 JSON 配置信息到你的 MCP 客户端设置中，无需修改代码：

Cursor 配置

在 Cursor 的 MCP 设置中，添加新的 MCP 服务器，配置信息如下：

{
  "serverName": "terraform-registry",
  "command": "npx",
  "args": ["-y", "terraform-mcp-server"]
}
  • serverName: 服务器名称，可以自定义，例如 "terraform-registry"。
  • command: 启动服务器的命令，这里使用 'npx' 来运行 'terraform-mcp-server'，'terraform-mcp-server' 是在 'package.json' 中定义的启动脚本，指向 'dist/index.js'。
  • args: 命令参数，'"-y"' 参数用于 'npx' 自动安装 'terraform-mcp-server' 包（如果尚未安装）。

Claude Desktop 配置

在 Claude Desktop 的开发者配置中，编辑 'claude_desktop_config.json' 文件，在 '"mcpServers"' 字段下添加以下配置：

{
  "serverName": "terraform-registry",
  "command": "npx",
  "args": ["-y", "terraform-mcp-server"]
}
  • serverName: 服务器名称，可以自定义，例如 "terraform-registry"。
  • command: 启动服务器的命令，这里使用 'npx'。
  • args: 命令参数，'"-y"' 和 '"terraform-mcp-server"'。

注意: 请确保你的 MCP 客户端能够找到 'npx' 命令。通常情况下，如果 Node.js 和 npm 安装正确，'npx' 应该在系统的 PATH 环境变量中。

基本使用方法

  1. 启动 MCP 服务器: 按照上述安装步骤启动 Terraform Registry MCP Server。
  2. 配置 MCP 客户端: 在你的 MCP 客户端（如 Cursor 或 Claude Desktop）中，按照上述配置示例添加并启用 Terraform Registry MCP Server。
  3. 在 MCP 客户端中使用工具: 在 MCP 客户端中，你可以通过自然语言指令或特定的调用方式来使用 Terraform Registry MCP Server 提供的工具。例如，你可以询问 AI Agent "查找 AWS Provider 的最新版本" 或 "获取 aws_instance resource 的使用示例"。
  4. AI Agent 调用工具: MCP 客户端会将你的请求转换为 MCP 协议的 'tools/call' 请求发送给 Terraform Registry MCP Server。
  5. 服务器返回信息: Terraform Registry MCP Server 会处理请求，调用相应的工具，从 Terraform Registry API 获取数据，并将结果以 MCP 协议的响应格式返回给 MCP 客户端。
  6. 客户端展示信息: MCP 客户端接收到响应后，会将结果以易于理解的方式呈现给你，例如文本或代码片段。

通过以上步骤，你就可以在 MCP 客户端中使用 Terraform Registry MCP Server 提供的工具，方便地获取 Terraform Registry 的相关信息，辅助你进行 Terraform 配置和学习。

信息

分类

开发者工具

访问项目