Terragrunt Documentation

🚀 MCP Server: Terragrunt Documentation Provider

A server based on the Model Context Protocol (MCP), built with Deno and TypeScript, designed to provide documentation resources and services for Terragrunt.

🚀 Quick Start

Install Dependencies

npm install jsr

Run the Server

Run Directly with DENO

deno run -A main.ts

Deploy with Docker

First, build the image:

docker build -t mcp-terragrunt-docs .

Then, run the container:

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

Deploy with JSR

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

Configuration Example

Configuration File (claude_desktop_config.json)

Using DENO

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

Using Docker

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

Using JSR

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

✨ Features

• Automated Documentation Retrieval: Fetch Terragrunt documentation from GitHub in real-time.
• Multiple Deployment Methods: Support deployment via DENO, Docker, and JSR.
• Environment Variable Configuration: Simplify the authentication process by setting the GITHUB_TOKEN.

📚 Documentation

Summary

This project helps enhance the capabilities of AI agents by providing Terragrunt-related documentation resources. It supports multiple running modes, including direct use of DENO, deployment via Docker containers, and utilization of JSR (JavaScript package management tool).

Use Cases

• AI Developers: Integrate it into AI applications to enhance context understanding capabilities.
• DevOps Engineers: Assist in writing and optimizing Terragrunt configuration files.
• Educational Purposes: Use it to learn and demonstrate the practical application of the MCP protocol.

🤝 Contribution Guide

For detailed contribution guidelines, please refer to docs/CONTRIBUTING.md, which includes setup, code style, PR process, and codebase structure references.

🔒 Security Policy

For the project's security policy, please refer to SECURITY.md, including how to report vulnerabilities and responsible disclosure guidelines.

📄 License

This project is licensed under the MIT License.