Repo To Txt MCP

🚀 仓库转文本 - MCP服务器

这是一个用于分析并转换Git仓库为结构化文本文件的MCP服务器，能为大型语言模型（LLM）提供仓库上下文，助力其更好地理解和处理相关信息。

🚀 快速开始

安装所需的包

pip install -r requirements.txt
npm install

启动服务器

node smithery-wrapper.js

服务器地址

服务器将在http://localhost:8000可用

✨ 主要特性

• 仓库分析：可对本地和远程Git仓库进行分析。
• 结构化输出：生成的格式化文本包含文件夹结构和文件内容拼接。
• 文件过滤：能依据扩展名来包含或排除文件。
• 令牌管理：可通过令牌数量限制输出大小。
• 轻松集成：专为与Cursor的MCP系统无缝协作而设计。
• 跨平台：在Windows、macOS和Linux系统上均可使用。

📦 安装指南

先决条件

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

安装选项

有关详细安装说明，请参阅安装指南：

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

💻 使用示例

转换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的配置，用于管理MCP：

smithery install chromewillow/repo-to-txt-mcp

贡献

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

致谢

• 此项目基于repo-to-txt CLI工具的功能构建。
• 感谢FastMCP库简化了MCP服务器的创建。

📄 许可证

此项目根据MIT许可证发布 - 有关详细信息，请参阅LICENSE文件。