Terragrunt Documentation

🚀 MCP 服务器：Terragrunt 文档提供程序

这是一个基于 Model Context Protocol (MCP) 的服务器，由 Deno 和 TypeScript 构建，旨在为 Terragrunt 提供文档资源和服务，助力增强 AI 代理的能力。

🚀 快速开始

安装依赖

npm install jsr

运行服务器

使用 DENO 直接运行

deno run -A main.ts

使用 Docker 部署

首先构建镜像：

docker build -t mcp-terragrunt-docs .

然后运行容器：

docker run -it --rm \
  -e GITHUB_TOKEN=ghp_xxx... \
  mcp-terragrunt-docs

使用 JSR 部署

deno run -A jsr:@excoriate/mcp-terragrunt-docs@0.1.0

配置示例

配置文件 (claude_desktop_config.json)

使用 DENO

{
  "mcpServers": {
    "terragrunt_docs": {
      "command": "deno",
      "args": [
        "run",
        "-A",
        "main.ts"
      ],
      "env": {
        "GITHUB_TOKEN": "<YOUR_TOKEN>"
      },
    }
  }
}

使用 Docker

{
  "mcpServers": {
    "terragrunt_docs": {
      "command": "docker",
      "args": [
        "run",
        "-e", "GITHUB_TOKEN=<YOUR_TOKEN>", "mcp-terragrunt-docs"
      ],
      "env": {
        "GITHUB_TOKEN": "<YOUR_TOKEN>"
      }
    }
  }
}

使用 JSR

{
  "mcpServers": {
    "terragrunt_docs": {
      "command": "deno",
      "args": [
        "run",
        "-A",
        "jsr:@excoriate/mcp-terragrunt-docs@0.1.0"
      ],
      "env": {
        "GITHUB_TOKEN": "<YOUR_TOKEN>"
      }
    }
  }
}

✨ 主要特性

• 自动化文档获取：实时从 GitHub 获取 Terragrunt 文档。
• 多运行方式：支持 DENO、Docker 和 JSR 部署。
• 环境变量配置：通过设置 GITHUB_TOKEN 简化身份验证流程。

📦 使用场景

• AI 开发者：集成到 AI 应用中，增强上下文理解能力。
• DevOps 工程师：辅助编写和优化 Terragrunt 配置文件。
• 教育用途：用于学习和演示 MCP 协议的实际应用。

📚 详细文档

摘要

此项目通过提供与 Terragrunt 相关的文档资源，帮助增强 AI 代理的能力。它支持多种运行方式，包括直接使用 DENO、通过 Docker 容器以及利用 JSR（JavaScript 包管理工具）进行部署。

📄 许可证

本项目在 MIT License 下许可。

📚 贡献指南

有关贡献的详细指南，请参阅 docs/CONTRIBUTING.md，其中包括设置、代码风格、PR 流程和代码库结构参考。

📚 安全政策

有关项目的安全策略，请参阅 SECURITY.md，包括如何报告漏洞和负责任的披露指南。