MCP Terragrunt Docs

🚀 MCP Server

This project is an MCP (Model Context Protocol) server, primarily used to provide context information for Terragrunt.

🚀 Quick Start

This MCP server serves as a valuable tool for enhancing the interaction between AI assistants and Terragrunt. It provides essential context information, enabling AI assistants to better understand user needs and offer more accurate advice.

✨ Features

• Purpose: Provide Terragrunt-related context information for AI assistants (such as Claude) to enhance the interaction experience.
• Functions:
  • List document categories.
  • Search document content.
  • Get detailed information of specified documents.

📦 Installation

Clone the Repository

git clone https://github.com/yourusername/mcp-server.git
cd mcp-server

Install Dependencies

npm install

Configure the GitHub Token

Create a .env file:

GITHUB_TOKEN=your_token_here

Run the Server

Using Deno

Run directly:

deno run -A main.ts

Or use Justfile:

just run

Using Docker

Build the image:

docker build -t mcp-server .

Run the container:

docker run -it --rm -e GITHUB_TOKEN=your_token_here mcp-server

💻 Usage Examples

List Document Categories

curl http://localhost:8000/api/docs/categories

Search Documents

curl http://localhost:8000/api/docs/search?q=query_string

Get Specified Documents

curl http://localhost:8000/api/docs/{category}/{doc_id}

📚 Documentation

Contribution Guidelines

Please refer to CONTRIBUTING.md for detailed contribution guidelines.

Security Policy

For the project security policy, please check SECURITY.md.

📄 License

This project is licensed under the MIT License. See LICENSE for details.