GIT-Pilot

GIT-Pilot

GIT-Pilot 是一款强大的 GitHub 自动化与管理工具，可为 GitHub 操作提供全面的 API 封装。它通过基于 FastMCP 的服务简化与 GitHub 的交互，便于管理代码仓库、拉取请求、议题等。

🌟 功能

🔐 身份验证与安全

• 使用 Fernet 加密进行安全的令牌管理
• 令牌过期和自动清理
• 速率限制处理和自动重试
• 可配置的身份验证超时

📦 代码仓库管理

• 创建和管理代码仓库
• 处理分支和提交
• 文件操作（创建、更新、删除）
• 代码仓库搜索和筛选
• 提交比较和历史记录

🔄 拉取请求操作

• 创建和管理拉取请求
• 合并策略（合并、压缩、变基）
• 状态检查验证
• 冲突检测和处理
• 支持草稿 PR

📝 议题管理

• 创建和更新议题
• 标签管理
• 受理人管理
• 评论管理
• 议题搜索和筛选

🛠 技术特性

• 线程安全操作
• 资源管理
• 全面的错误处理
• 详细日志记录
• 类型安全
• 配置管理
• FastMCP 服务集成

🚀 开始使用

先决条件

• Python 3.12 或更高版本
• GitHub 账户
• GitHub Personal Access Token
• FastMCP CLI（可选）

安装

1. 克隆代码仓库：

git clone https://github.com/yourusername/GIT-Pilot.git
cd GIT-Pilot

2. 安装 uv（如果尚未安装）：

curl -LsSf https://astral.sh/uv/install.sh | sh

3. 创建并激活虚拟环境：

uv venv
source .venv/bin/activate  # On Windows: .venv\Scripts\activate

4. 使用 uv 安装软件包：

uv pip install -e .

5. 设置环境变量： 在项目根目录中创建一个 .env 文件：

GITHUB_TOKEN=your_github_token_here

基本用法

设置 Claude Desktop 集成

1. 启动 GIT-Pilot 服务：

uv run main.py

2. 下载并安装 Claude Desktop

3. 配置 Claude Desktop：

   • 打开 Claude Desktop
   • 前往 File > Settings > Developer > Edit Config
   • 添加以下配置：

{
    "mcpServers": {
        "GIT-Pilot": {
            "command": "uv",
            "args": [
                "--directory",
                "path\\to\\repo",
                "run",
                "main.py"
            ]
        }
    }
}

4. 重启 Claude Desktop
5. 在聊天窗口中找到锤子图标——这表示 MCP 服务已准备就绪

API 示例

# Create a repository
await call_tool("create_repository",
    name="my-repo",
    description="My awesome repository",
    private=True,
    has_issues=True,
    has_wiki=True,
    has_projects=True,
    auto_init=True
)

# Create a pull request
await call_tool("create_pull_request",
    repo_path="owner/repo",
    title="New feature",
    head="feature-branch",
    base="main",
    body="Description of changes",
    draft=False
)

# List commits with filtering
await call_tool("list_commits",
    repo_path="owner/repo",
    branch="main",
    author="username",
    since="2024-01-01",
    until="2024-04-21",
    max_results=30
)

🔧 配置

可通过 Config 类配置此服务：

@dataclass
class Config:
    TOKEN_TTL_HOURS: int = 24
    MAX_STORED_TOKENS: int = 1000
    CLEANUP_INTERVAL_SECONDS: int = 3600
    MAX_RETRIES: int = 3
    RETRY_DELAY_SECONDS: int = 5
    MAX_RESULTS_PER_PAGE: int = 100
    ENCRYPTION_KEY: bytes = Fernet.generate_key()

🛡 安全

• 使用 Fernet 对静态令牌进行加密
• 自动令牌过期和清理
• 通过重试机制防范速率限制
• 输入验证
• 全面的错误处理
• 安全清理令牌

🔄 速率限制

此服务内置了速率限制处理：

• 触发速率限制时自动重试
• 可配置重试次数
• 重试间隔延迟
• 速率限制状态日志记录
• 指数退避

🧪 错误处理

全面处理以下错误：

• 身份验证失败
• API 错误
• 速率限制
• 无效输入
• 资源冲突
• 网络问题
• 令牌验证
• 文件操作

📈 日志记录

详细记录以下信息：

• 时间戳
• 日志级别
• 函数名称
• 行号
• 错误详情
• 堆栈跟踪
• 速率限制信息
• 令牌操作

🤝 参与贡献

欢迎贡献！请按以下步骤操作：

1. Fork 此代码仓库
2. 创建功能分支
3. 提交更改
4. 推送到分支
5. 创建 Pull Request

📝 许可证

本项目采用 GNU General Public License v3.0 许可，详情请参阅 LICENSE 文件。

🙏 致谢

• PyGithub：提供 GitHub API 封装
• FastMCP：提供服务端框架
• Fernet：用于安全地加密令牌

---

由 GIT-Pilot 团队倾心打造 ❤️