使用GitHub Toolkit与仓库互动的实战指南

最新推荐文章于 2025-12-23 14:33:53 发布

原创最新推荐文章于 2025-12-23 14:33:53 发布 · 468 阅读

CC 4.0 BY-SA版权

文章标签：

在现代软件开发环境中，自动化工作流已经成为提高开发效率和代码质量的关键之一。GitHub Toolkit提供了一套强大的工具，使得开发者可以通过语言模型代理（LLM Agent）与GitHub仓库进行交互。本文将详细介绍如何设置和使用GitHub Toolkit，以便您的代理可以与GitHub有效地协同工作。

技术背景介绍

GitHub Toolkit是一个基于PyGitHub库的封装工具，可让语言模型代理与GitHub仓库进行互动，比如获取问题、创建和管理拉取请求、更新文件等等。这种能力特别适合自动化项目管理和代码评审的场景。

核心原理解析

该工具主要通过GitHub API进行操作，代理通过API获取和修改仓库中的内容。工具包提供了多种工具，以执行特定的Git操作，每一个工具都封装成一个功能模块，例如获取问题列表、创建文件、更新文件等。

代码实现演示

在进行实际操作前，我们需要完成一些基础设置，例如安装依赖库、创建GitHub应用以及设置环境变量。

安装依赖

首先，安装所需的库：

%pip install --upgrade --quiet pygithub langchain-community

创建GitHub应用

请按照GitHub的官方文档创建并注册一个GitHub应用，并确保您的应用具有必要的仓库权限。

设置环境变量

在初始化代理之前，需要设置以下环境变量：

import os
import getpass

# 确保环境变量已设置
for env_var in ["GITHUB_APP_ID", "GITHUB_APP_PRIVATE_KEY", "GITHUB_REPOSITORY"]:
    if not os.getenv(env_var):
        os.environ[env_var] = getpass.getpass(f"Enter {env_var}: ")

# 可选参数
os.environ["GITHUB_BRANCH"] = "main"  # 指定分支，默认为default_branch

工具包初始化

接下来，我们可以实例化工具包并获取可用工具：

from langchain_community.agent_toolkits.github.toolkit import GitHubToolkit
from langchain_community.utilities.github import GitHubAPIWrapper

# 初始化GitHubAPIWrapper
github = GitHubAPIWrapper()
# 从API Wrapper中创建工具包
toolkit = GitHubToolkit.from_github_api_wrapper(github)

# 查看可用工具
tools = toolkit.get_tools()
for tool in tools:
    print(tool.name)

使用工具获取指定问题的标题

以下是一个简单的例子，展示如何使用工具包获取特定问题的标题：

from langgraph.prebuilt import create_react_agent

# 选择需要的工具
tools = [tool for tool in toolkit.get_tools() if tool.name == "Get Issue"]
tools[0].name = "get_issue"

# 创建AgentExecutor
agent_executor = create_react_agent(llm, tools)

# 查询特定的问题标题
example_query = "What is the title of issue 24888?"

events = agent_executor.stream(
    {"messages": [("user", example_query)]},
    stream_mode="values",
)
for event in events:
    event["messages"][-1].pretty_print()