repo-to-txt-mcp

repo-to-txt-mcp

用于分析 Git 仓库并将其转换为文本文件、为大模型提供上下文的 MCP 服务。

概述

repo-to-txt-mcp 是一个机器代码协议（MCP）服务，可分析 GitHub 仓库或本地文件夹，并将其转换为结构化文本文件。此功能尤其适用于向 GPT-4 等大语言模型（LLM）提供仓库上下文。

本项目扩展了 repo-to-txt 命令行工具的功能，提供可集成到其他应用中的 Web API，尤其适用于 Cursor 的 MCP 系统。

功能

• 仓库分析：分析本地和远程 Git 仓库
• 结构化输出：生成包含文件夹结构和拼接后文件内容的格式化文本
• 文件筛选：根据扩展名包含或排除文件
• Token 管理：按 Token 数量限制输出大小
• 轻松集成：专为与 Cursor 的 MCP 系统无缝协作而设计
• 跨平台：支持 Windows、macOS 和 Linux

安装

先决条件

• Python 3.8+
• Node.js 14+
• Git

安装选项

详细说明请参阅安装指南，内容包括：

• 直接安装
• Docker 安装
• GitHub Container Registry 使用方法

快速开始

1. 安装所需的软件包：

   pip install -r requirements.txt
   npm install
   

2. 启动服务：

   node smithery-wrapper.js
   

3. 服务将在 http://localhost:8000 上提供

API 使用方法

转换 GitHub 仓库

curl -X POST http://localhost:8000/analyze \
  -H "Content-Type: application/json" \
  -d '{
    "source": "https://github.com/username/repository",
    "return_file": true
  }'

按文件扩展名筛选

curl -X POST http://localhost:8000/analyze \
  -H "Content-Type: application/json" \
  -d '{
    "source": "https://github.com/username/repository",
    "include_only": [".py", ".js", ".md"],
    "exclude": [".pyc", ".git"]
  }'

完整详情请参阅 API 文档。

Cursor 集成

此服务旨在与 Cursor 集成，在对话期间向语言模型提供仓库上下文。

有关如何设置和使用此功能的说明，请参阅 Cursor 集成指南。

Docker 支持

项目包含一个 Dockerfile，便于进行容器化部署：

docker build -t repo-to-txt-mcp .
docker run -p 8000:8000 repo-to-txt-mcp

Smithery 集成

本项目包含 Smithery 的配置。Smithery 是用于管理 MCP 的工具：

smithery install chromewillow/repo-to-txt-mcp

贡献

欢迎贡献！请参阅 CONTRIBUTING.md 了解相关指南。

许可证

本项目采用 MIT 许可证，详情请参阅 LICENSE 文件。

致谢

• 本项目基于 repo-to-txt 命令行工具的功能构建
• 感谢 FastMCP 库简化了 MCP 服务的创建