MCP Server: Terragrunt Docs Provider

MCP Server: Terragrunt Docs Provider

site icon
2025.04.22 2
TypeScriptTerragrunt 文档GitHub 问题跟踪开发效率
mcp-terragrunt-docs 是一个基于 Deno 和 TypeScript 构建的 Model Context Protocol (MCP) 服务器,旨在为 Terragrunt 提供上下文信息。该服务器通过暴露工具和资源,允许 AI 代理或其他 MCP 客户端查询 Terragrunt 文档和开发信息(如 GitHub 问题)。其主要功能包括提供 Terragrunt 文档分类、文档内容查询以及 GitHub 问题跟踪等。适用于需要增强 Terragrunt 开发体验的场景,特别是在 IDE 支持不足时,通过提供最新的文档和问题信息,帮助开发者获得更准确的自动补全和错误提示。
View on GitHub

Overview

基本能力

产品定位

mcp-terragrunt-docs 是一个为 Terragrunt 开发者提供上下文信息的 MCP 服务器,旨在增强 Terragrunt 的开发体验,特别是在 IDE 支持不足的情况下。

核心功能

  • 提供 Terragrunt 文档分类查询
  • 提供特定分类下的文档列表和内容查询
  • 提供 Terragrunt GitHub 仓库的开放问题查询

适用场景

  • 在 IDE 中增强 Terragrunt 的自动补全功能
  • 提供最新的 Terragrunt 文档和问题信息,帮助开发者获得更准确的开发支持
  • 构建 Terragrunt 文档导航系统或问题跟踪工具

工具列表

  1. list-doc-categories: 检索 Terragrunt 文档的所有分类
  2. list-all-docs-by-category: 列出特定分类下的所有文档
  3. read-document-from-category: 读取特定分类下的特定文档内容
  4. read-all-docs-from-category: 检索并合并特定分类下的所有文档
  5. get-all-open-issues: 检索 Terragrunt GitHub 仓库的所有开放问题

常见问题解答

  • 所有工具都需要有效的 GitHub token,可以通过环境变量 GITHUB_TOKENGH_TOKENGITHUB_PERSONAL_ACCESS_TOKEN 设置。

使用教程

使用依赖

  1. 安装 Deno: Deno Installation Guide

安装教程

  1. 克隆仓库: sh git clone https://github.com/Excoriate/mcp-terragrunt-docs.git cd mcp-terragrunt-docs
  2. 设置 GitHub token 环境变量:
  3. Unix/macOS: sh export GITHUB_TOKEN=ghp_xxx...
  4. Windows (cmd): cmd set GITHUB_TOKEN=ghp_xxx...

调试方式

  1. 运行 MCP 服务器: sh deno run -A main.ts
  2. 使用 JSR 运行: sh deno run -A jsr:@excoriate/[email protected]
  3. 构建并运行 Docker 镜像: sh docker build -t mcp-terragrunt-docs . docker run -it --rm -e GITHUB_TOKEN=ghp_xxx... mcp-terragrunt-docs

许可证

该项目遵循 MIT 开源许可条款,请参阅 MIT 了解完整条款。