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文件。