Terragrunt Documentation

🚀 MCP サーバー：Terragrunt ドキュメントプロバイダー

このプロジェクトは、Model Context Protocol (MCP) をベースにしたサーバーで、Deno と TypeScript で構築されています。Terragrunt のドキュメントリソースとサービスを提供することを目的としています。

🚀 クイックスタート

このサーバーを使用するには、以下の手順に従ってください。

依存関係のインストール

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 を設定することで、認証プロセスを簡素化します。

📚 ドキュメント

概要

このプロジェクトは、Terragrunt に関連するドキュメントリソースを提供することで、AI エージェントの機能を強化することを目的としています。DENO を直接使用する方法、Docker コンテナを使用する方法、JSR（JavaScript パッケージ管理ツール）を使用する方法など、複数の実行方法をサポートしています。

使用シーン

• AI 開発者：AI アプリケーションに統合して、コンテキスト理解能力を強化します。
• DevOps エンジニア：Terragrunt の設定ファイルの作成と最適化を支援します。
• 教育目的：MCP プロトコルの実際のアプリケーションを学習およびデモンストレーションするために使用します。

🤝 貢献ガイド

貢献に関する詳細なガイドは、docs/CONTRIBUTING.md を参照してください。ここには、セットアップ、コードスタイル、PR フロー、およびコードベースの構造に関する参考情報が含まれています。

🔒 セキュリティポリシー

このプロジェクトのセキュリティポリシーについては、SECURITY.md を参照してください。ここには、脆弱性の報告方法と責任ある開示ガイドラインが含まれています。

📄 ライセンス

このプロジェクトは MIT License の下でライセンスされています。