article
README
🚀 Gitingest - MCP
Gitingest - MCP 是一个为 gitingest 提供支持的 MCP 服务端。借助该服务端,像 Claude Desktop、Cline、Cursor 等 MCP 客户端能够快速提取 Github 仓库的相关信息,具体包括:
- 仓库摘要
- 项目目录结构
- 文件内容
🚀 快速开始
本项目提供了便捷的方式让 MCP 客户端快速提取 Github 仓库的信息,下面将详细介绍安装和调试的步骤。
✨ 主要特性
- 支持多种 MCP 客户端,如 Claude Desktop、Cline、Cursor 等。
- 能够快速提取 Github 仓库的摘要、目录结构和文件内容。
📦 安装指南
通过 Smithery 安装
要通过 Smithery 安装 gitingest - mcp,可根据不同的客户端使用以下命令:
npx -y @smithery/cli@latest install @puravparab/gitingest-mcp --client claude --config "{}" # 适用于 Claude
npx -y @smithery/cli@latest run @puravparab/gitingest-mcp --client cursor --config "{}" # 适用于 Cursor
npx -y @smithery/cli@latest install @puravparab/gitingest-mcp --client windsurf --config "{}" # 适用于 Windsurf
npx -y @smithery/cli@latest install @puravparab/gitingest-mcp --client cline --config "{}" # 适用于 Cline
通过 Github 安装
- 将以下内容添加到 MCP 客户端配置文件中:
{
"mcpServers": {
"gitingest-mcp": {
"command": "<uv路径>/uvx",
"args": [
"--from",
"git+https://github.com/puravparab/gitingest-mcp",
"gitingest-mcp"
]
}
}
}
手动安装仓库
- 克隆仓库:
git clone https://github.com/puravparab/Gitingest-MCP
cd Gitingest-MCP
- 安装依赖项:
uv sync
- 将以下内容添加到 MCP 客户端配置文件中:
{
"mcpServers": {
"gitingest-mcp": {
"command": "<uv路径>/uvx",
"args": [
"--from",
"git+https://github.com/puravparab/gitingest-mcp",
"gitingest-mcp"
]
}
}
}
更新 MCP 客户端配置
- 打开 MCP 客户端的配置文件。
- 添加以下内容到
mcpServers部分:
{
"gitingest-mcp": {
"command": "<uv路径>/uvx",
"args": [
"--from",
"git+https://github.com/puravparab/gitingest-mcp",
"gitingest-mcp"
]
}
}
🔧 调试
- 打开终端并运行以下命令:
uv run server.py
- 确保服务器已正确配置并在运行中。
Scan to join WeChat group