mcp-terragrunt-docs

🚀 MCP（模型上下文协议）服务器

本项目是一个MCP（模型上下文协议）服务器，主要为Terragrunt提供上下文信息，为AI助手（如Claude）提供支持，增强与开发者的交互体验，助力开发者高效获取Terragrunt文档信息。

🚀 快速开始

克隆仓库

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

安装依赖

npm install

配置GitHub令牌

创建一个.env文件：

GITHUB_TOKEN=your_token_here

运行服务器

使用Deno

直接运行：

deno run -A main.ts

或使用Justfile：

just run

使用Docker

构建镜像：

docker build -t mcp-server .

运行容器：

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

✨ 主要特性

• 目的：为AI助手（如Claude）提供Terragrunt相关的上下文信息，增强交互体验。
• 功能：
  • 列出文档类别
  • 搜索文档内容
  • 获取指定文档的详细信息

📦 安装指南

按照上述“快速开始”中的步骤进行克隆仓库、安装依赖、配置令牌和运行服务器。

💻 使用示例

基础用法

列出文档类别

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

搜索文档

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

获取指定文档

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

📚 详细文档

使用场景

• 提升效率：帮助开发者快速获取 Terragrunt 文档信息。
• 辅助决策：为AI助手提供上下文，使其能更好地理解用户意图并提供建议。

贡献指南

请参阅CONTRIBUTING.md了解详细贡献指南。

安全政策

项目安全政策，请查看SECURITY.md。

📄 许可证

本项目采用MIT许可证，具体条款见LICENSE。