Repo To Txt MCP

🚀 Repository to Text - MCP Server

An MCP server for analyzing and converting Git repositories into structured text files, enabling large language models (LLMs) to access context.

🚀 Quick Start

1. Install the required packages:

   pip install -r requirements.txt
   npm install
   

2. Start the server:

   node smithery-wrapper.js
   

3. The server will be available at http://localhost:8000

✨ Features

• Repository Analysis: Analyze both local and remote Git repositories.
• Structured Output: Generate formatted text that combines folder structures and file contents.
• File Filtering: Include or exclude files based on their extensions.
• Token Management: Limit the output size by the number of tokens.
• Easy Integration: Designed to work seamlessly with Cursor's MCP system.
• Cross - Platform: Compatible with Windows, macOS, and Linux.

📦 Installation

Prerequisites

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

Installation Options

For detailed installation instructions, refer to the Installation Guide:

• Direct installation
• Docker installation
• Use of GitHub Container Registry

💻 Usage Examples

Converting a GitHub Repository

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

Filtering by File Extension

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"]
  }'

For full details, refer to the API Documentation.

📚 Documentation

Overview

repo-to-txt-mcp is a Machine Code Protocol (MCP) server that allows you to analyze GitHub repositories or local folders and convert them into structured text files. This is particularly useful for providing repository context to large language models like GPT - 4.

This project extends the functionality of the repo-to-txt CLI tool to provide a Web API that can be integrated with other applications, especially Cursor's MCP system.

Cursor Integration

This server is designed to integrate with Cursor to provide repository context to the language model during conversations.

For instructions on setting up and using this feature, refer to the Cursor Integration Guide.

Docker Support

A Dockerfile is included to facilitate containerized deployment:

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

Smithery Integration

This project includes Smithery configuration for managing MCP:

smithery install chromewillow/repo-to-txt-mcp

Contribution

Contributions are welcome! Please refer to CONTRIBUTING.md for guidelines.

Acknowledgments

• This project is built on the functionality of the repo-to-txt CLI tool.
• Thanks to the FastMCP library for simplifying the creation of MCP servers.

📄 License

This project is released under the MIT License - for details, see the LICENSE file.