repo-to-txt-mcp

一个用于分析和转换 Git 仓库为文本文件，以供 LLM 上下文使用的 MCP 服务器。

概述

repo-to-txt-mcp 是一个机器码协议 (MCP) 服务器，允许您分析 GitHub 仓库或本地文件夹，并将它们转换为结构化的文本文件。这对于向大型语言模型 (LLM)（如 GPT-4）提供有关仓库的上下文信息特别有用。

本项目扩展了 repo-to-txt CLI 工具的功能，提供了一个可以集成到其他应用程序（特别是 Cursor 的 MCP 系统）中的 Web API。

特性

• 仓库分析: 分析本地和远程 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 CLI 工具的功能构建
• 感谢 FastMCP 库简化了 MCP 服务器的创建