AI导哈

仓库文本转换服务

一个用于将Git仓库或本地文件夹转换为结构化文本文件的服务，特别适用于为大型语言模型提供仓库上下文。

  • by chromewillow
  • Python
  • 本地部署
  • 更新于
在 GitHub 查看 chromewillow/repo-to-txt-mcp

使用说明

回购到txt mcp

一个MCP服务器，用于分析Git存储库并将其转换为LLM上下文的文本文件。

概述

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

该项目扩展了 repo转txt CLI工具，提供可集成到其他应用程序中的web API，特别是Cursor的MCP系统。

特性

  • 存储库分析：分析本地和远程Git存储库
  • 结构化输出：生成具有文件夹结构和连接文件内容的格式化文本
  • 文件筛选：根据扩展名包含或排除文件
  • 许可证管理：通过令牌计数限制输出大小
  • 易于集成：设计用于与Cursor的MCP系统无缝协作
  • 交叉平台的：适用于Windows、macOS和Linux

安装

先决条件

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

安装选项

请参阅 安装指南 有关以下内容的详细说明：

  • 直接安装
  • Docker安装
  • GitHub容器注册表使用情况

快速开始

  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集成，以便在对话期间为语言模型提供存储库上下文。

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

Docker支持

为了便于容器化部署，我们提供了一个Dockerfile：

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

Smithery集成

该项目包括管理MCP的工具Smithery的配置：

smithery install chromewillow/repo-to-txt-mcp

贡献

欢迎投稿！请看 贡献.md 作为指导方针。

许可证

此项目根据MIT许可证获得许可-请参阅 许可证 文件以获取详细信息。

致谢

  • 该项目基于 repo转txt CLI工具
  • 感谢FastMCP库简化了MCP服务器的创建

相关 MCP