article
README
🚀 Terraform Cloud MCP 服务器
Terraform Cloud MCP 服务器是基于 Model Context Protocol (MCP) 的服务,可与 Terraform Cloud 交互。它提供了丰富工具和功能,助力用户管理和操作云基础设施。
🚀 快速开始
📦 安装指南
# 克隆仓库
git clone https://github.com/severity1/terraform-cloud-mcp.git
cd terraform-cloud-mcp
# 创建虚拟环境并激活
uv venv
source .venv/bin/activate # 在 Windows 系统中使用:.venv\Scripts\activate
# 安装依赖项
uv pip install .
运行服务器
# 以开发模式运行服务器
mcp dev terraform_cloud_mcp/server.py
✨ 主要特性
- 自动化运行管理:通过 MCP 协议实现对 Terraform 运行的自动化控制。
- 详细日志记录:默认启用调试日志,便于排查问题。
- MCP 检查器集成:内置检查工具(访问地址:http://localhost:5173)用于调试和监控。
📚 详细文档
开发指南
快速开发环境搭建
# 克隆仓库
git clone https://github.com/severity1/terraform-cloud-mcp.git
cd terraform-cloud-mcp
# 创建虚拟环境并激活
uv venv
source .venv/bin/activate # 在 Windows 系统中使用:.venv\Scripts\activate
# 安装开发版本及依赖项
uv pip install -e .
uv pip install black mypy pydantic ruff
基本开发命令
# 运行服务器
mcp dev terraform_cloud_mcp/server.py
# 执行测试和代码检查
uv run -m mypy .
uv run -m ruff check .
uv run -m black .
文档资源
- 代码注释:重点解释实现决策背后的“原因”。
- 文档字符串:所有公开函数和类均包含详细说明。
- 示例文件:
docs/DEVELOPMENT.md:开发标准和编程指南。docs/CONTRIBUTING.md:贡献项目的指导方针。docs/models/:所有模型类型的使用示例。docs/tools/:每个工具的详细用法说明。docs/conversations/:与 API 交互的示例对话流程。
🔧 技术细节
故障排除
- 检查服务器日志(默认启用调试记录)。
- 使用 MCP 检查器进行调试(访问地址:http://localhost:5173)。
- 在
server.py中已启用调试记录:import logging logging.basicConfig(level=logging.DEBUG)
🤝 贡献指南
欢迎贡献!请通过提交问题或拉取请求参与项目。
详细信息请参阅 CONTRIBUTING.md,了解如何开始、代码质量标准及拉取请求流程。
Scan to contact