基本能力
产品定位
mcp-repo2llm 是一个专为开发者和 AI 研究人员设计的工具,旨在将代码仓库转换为适合大型语言模型(LLM)处理的格式,从而提升 AI 工具在代码分析和生成中的效果。
核心功能
- 智能仓库扫描:智能处理整个代码库,保持结构完整性。
- 上下文保留:保留代码文件间的重要上下文信息和关系。
- 多语言支持:支持多种编程语言,并针对每种语言进行优化。
- 元数据增强:为代码添加相关元数据,以提升 LLM 的理解能力。
- 高效处理:优化资源使用,适合处理大型代码仓库。
适用场景
- 开发者希望将代码仓库输入到 LLM 中进行代码分析或生成。
- AI 研究人员需要优化代码仓库的输入格式以提升模型效果。
- 团队希望自动化处理多语言代码仓库,以便于 AI 工具的统一处理。
工具列表
- get_gitlab_repo:从 GitLab 仓库分支获取代码并转换为文本。
- 输入:
repo_url
(GitLab 仓库 URL)、branch
(分支名,默认为 master)。 -
输出:仓库的所有信息和结构文本。
-
get_github_repo:从 GitHub 仓库分支获取代码并转换为文本。
- 输入:
repo_url
(GitHub 仓库 URL)、branch
(分支名,默认为 master)。 -
输出:仓库的所有信息和结构文本。
-
get_local_repo:从本地 Git 仓库获取代码并转换为文本。
- 输入:
repo_url
(本地仓库路径)。 - 输出:仓库的所有信息和结构文本。
使用教程
使用依赖
安装前需确保已安装 uv
工具,并配置好 GITHUB_TOKEN
和 GITLAB_TOKEN
环境变量。
安装教程
通过 uv
安装 mcp-repo2llm:
bash
uv run --with mcp[cli] --with-editable /mcp-repo2llm mcp run /mcp-repo2llm/mcp-repo2llm-server.py
环境变量配置示例:
bash
export GITHUB_TOKEN="your-github-token"
export GITLAB_TOKEN="your-gitlab-token"
调试方式
安装完成后,可以通过以下命令测试工具功能:
```bash
测试 GitLab 仓库处理
uv run --with mcp[cli] mcp-repo2llm get_gitlab_repo --repo_url "https://gitlab.com/your/repo" --branch "master"
测试 GitHub 仓库处理
uv run --with mcp[cli] mcp-repo2llm get_github_repo --repo_url "https://github.com/your/repo" --branch "main"
测试本地仓库处理
uv run --with mcp[cli] mcp-repo2llm get_local_repo --repo_url "/path/to/your/local/repo"
```