Terragrunt Docs

Provides up-to-date Terragrunt docs and GitHub issues data for MCP clients to query and use in AI-assisted development.

typescript

16

GitHub Stars

typescript

Language

6 months ago

First Indexed

2 months ago

Catalog Refreshed

Documentation & install

Readme and setup notes from the catalogue, plus a client-ready config you can copy for your MCP host.

Installation

Add the following to your MCP client configuration file.

Configuration

View docs

{
  "mcpServers": {
    "excoriate-mcp-terragrunt-docs": {
      "command": "docker",
      "args": [
        "run",
        "-it",
        "--rm",
        "-e",
        "GITHUB_TOKEN=YOUR_TOKEN",
        "mcp-terragrunt-docs"
      ],
      "env": {
        "GH_TOKEN": "ghp_abcdef...",
        "GITHUB_TOKEN": "YOUR_TOKEN"
      }
    }
  }
}

You run an MCP server that provides Terragrunt documentation data and issue information to clients and AI assistants. It lets you fetch docs, merge categories, and surface open Terragrunt issues, enabling accurate, up-to-date guidance for Terragrunt development workflows.

How to use

To use the Terragrunt Docs MCP server, connect your MCP client or Claude-like agent to one of the available stdio runtimes or to a running Deno process. The server exposes tools for exploring Terragrunt documentation and for retrieving GitHub issues related to Terragrunt. Use it to keep your AI assistant informed with current docs and project discussions when you work on Terragrunt configurations.

How to install

Prerequisites: you need a runtime to start the MCP server. You can run it directly with Deno, or use a containerized approach with Docker. You also need a GitHub token to access private or rate-limited data.

Option A: Run directly with Deno (development-friendly)

deno run -A main.ts

Option B: Run via Docker (production-friendly)

docker build -t mcp-terragrunt-docs .

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

Option C: Use a JavaScript/JSR-based runtime (JSR) to start the MCP via a package pin

export GITHUB_TOKEN=ghp_xxx...

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

Additional sections

Security and access: provide a GitHub token with appropriate permissions as an environment variable. The server reads this token to access GitHub data when you enable issue retrieval and documentation features.

Configuration notes: you can run the server directly for development or pair it with a build-and-run flow for production. When using Docker, pass the token as an environment variable on startup.

Examples and notes: you can fetch all documentation categories, list docs within a category, read a single document, merge all docs from a category, and retrieve open Terragrunt issues. These capabilities are exposed through the MCP interface to your AI assistants or other MCP clients.

Available tools

list-doc-categories

Retrieve all documentation categories from Terragrunt docs. Returns an array of objects with name and link.

list-all-docs-by-category

List all docs in a specific category. Returns docs with name, link, and content.

read-document-from-category

Read a specific doc from a category. Returns the full markdown content.

read-all-docs-from-category

Retrieve and merge all docs in a category into one response, giving a comprehensive view of that topic.

get-all-open-issues

Retrieve all open issues from the Terragrunt GitHub repository, including titles, numbers, states, timestamps, bodies, and labels.