Class GitHubTools

java.lang.Object

com.example.github.GitHubTools

public final class GitHubTools
extends Object

Reusable GitHub function tools backed by the org.kohsuke:github-api client. Each returns a Map with a "status" of "success", "error" or "dry_run". Reads GITHUB_TOKEN from the environment; callers set dryRun to gate writes.

The tools cover the operations needed by the ADK GitHub automation samples: reading releases, diffs and file contents; searching code; listing and reading issues and their comments; listing repository collaborators; creating issues and pull requests; labelling/assigning issues; commenting on or closing issues; and reading, labelling and commenting on pull requests.

Defense in depth against prompt injection: the agents read untrusted GitHub content (diffs, file contents, issue/PR titles) and could be steered into harmful writes. Independently of the prompt, the write tools (a) only target writeRepoOwner/writeRepoName when set, (b) restrict pull requests to Markdown files under docs/, and (c) cap how many issues and pull requests a single run may create. The labelling/assignment/commenting tools are not separately capped: unlike issue/PR creation they do not create new objects (so they carry no unbounded-spam risk) and only mutate pre-existing issues or pull requests in the pinned target repository from (a); the consuming triaging agents additionally bind them to a fixed label allowlist and the specific issue/PR numbers the workflow authorized.

Field Summary

Fields

Modifier and Type	Field	Description
static boolean	dryRun	When true, create_issue/create_pull_request return a preview instead of writing.
static String	writeRepoName
static String	writeRepoOwner	When both are set, create_issue/create_pull_request refuse to write to any other repository, regardless of the owner/repo the model passes.

Method Summary

Modifier and Type	Method	Description
static Map<String,Object>	addCommentToIssue(String repoOwner, String repoName, int issueNumber, String body)
static Map<String,Object>	addCommentToPullRequest(String repoOwner, String repoName, int prNumber, String comment)
static Map<String,Object>	addLabelToIssue(String repoOwner, String repoName, int issueNumber, String label)
static Map<String,Object>	addLabelToPullRequest(String repoOwner, String repoName, int prNumber, String label)
static Map<String,Object>	assignIssue(String repoOwner, String repoName, int issueNumber, List<String> assignees)
static Map<String,Object>	closeIssue(String repoOwner, String repoName, int issueNumber)
static Map<String,Object>	createIssue(String repoOwner, String repoName, String title, String body)
static Map<String,Object>	createPullRequest(String repoOwner, String repoName, String baseBranch, List<String> filePaths, List<String> newContents, String title, String body)
static Map<String,Object>	findDocIssues(String repoOwner, String repoName, String codeRepo)
static Map<String,Object>	findPullRequestsForIssue(String repoOwner, String repoName, int issueNumber)
static Map<String,Object>	getChangedFiles(String repoOwner, String repoName, String startTag, String endTag, String pathFilter)
static Map<String,Object>	getFileContent(String repoOwner, String repoName, String filePath)
static Map<String,Object>	getFileDiff(String repoOwner, String repoName, String startTag, String endTag, String filePath)
static Map<String,Object>	getIssue(String repoOwner, String repoName, int issueNumber)
static Map<String,Object>	getIssueComments(String repoOwner, String repoName, int issueNumber)
static Map<String,Object>	getPullRequest(String repoOwner, String repoName, int prNumber)
static Map<String,Object>	listOpenIssues(String repoOwner, String repoName, Integer maxResults)
static Map<String,Object>	listOpenIssuesUpdatedSince(String repoOwner, String repoName, String updatedSince, Integer maxResults)
static Map<String,Object>	listReleases(String repoOwner, String repoName)
static Map<String,Object>	listRepositoryCollaborators(String repoOwner, String repoName)
static Map<String,Object>	removeLabelFromIssue(String repoOwner, String repoName, int issueNumber, String label)
static Map<String,Object>	searchCode(String repoOwner, String repoName, String query)

Methods inherited from class Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Field Details

dryRun

public static boolean dryRun

When true, create_issue/create_pull_request return a preview instead of writing.

writeRepoOwner

public static String writeRepoOwner

When both are set, create_issue/create_pull_request refuse to write to any other repository, regardless of the owner/repo the model passes. Set by the entry point to the docs repository so untrusted content cannot redirect writes elsewhere.

writeRepoName

public static String writeRepoName

Method Details

listReleases

public static Map<String,Object> listReleases(String repoOwner,
 String repoName)

getChangedFiles

public static Map<String,Object> getChangedFiles(String repoOwner,
 String repoName,
 String startTag,
 String endTag,
 String pathFilter)

getFileDiff

public static Map<String,Object> getFileDiff(String repoOwner,
 String repoName,
 String startTag,
 String endTag,
 String filePath)

searchCode

public static Map<String,Object> searchCode(String repoOwner,
 String repoName,
 String query)

getFileContent

public static Map<String,Object> getFileContent(String repoOwner,
 String repoName,
 String filePath)

createIssue

public static Map<String,Object> createIssue(String repoOwner,
 String repoName,
 String title,
 String body)

findDocIssues

public static Map<String,Object> findDocIssues(String repoOwner,
 String repoName,
 String codeRepo)

findPullRequestsForIssue

public static Map<String,Object> findPullRequestsForIssue(String repoOwner,
 String repoName,
 int issueNumber)

createPullRequest

public static Map<String,Object> createPullRequest(String repoOwner,
 String repoName,
 String baseBranch,
 List<String> filePaths,
 List<String> newContents,
 String title,
 String body)

listOpenIssues

public static Map<String,Object> listOpenIssues(String repoOwner,
 String repoName,
 Integer maxResults)

listOpenIssuesUpdatedSince

public static Map<String,Object> listOpenIssuesUpdatedSince(String repoOwner,
 String repoName,
 String updatedSince,
 Integer maxResults)

getIssue

public static Map<String,Object> getIssue(String repoOwner,
 String repoName,
 int issueNumber)

getIssueComments

public static Map<String,Object> getIssueComments(String repoOwner,
 String repoName,
 int issueNumber)

listRepositoryCollaborators

public static Map<String,Object> listRepositoryCollaborators(String repoOwner,
 String repoName)

addLabelToIssue

public static Map<String,Object> addLabelToIssue(String repoOwner,
 String repoName,
 int issueNumber,
 String label)

removeLabelFromIssue

public static Map<String,Object> removeLabelFromIssue(String repoOwner,
 String repoName,
 int issueNumber,
 String label)

assignIssue

public static Map<String,Object> assignIssue(String repoOwner,
 String repoName,
 int issueNumber,
 List<String> assignees)

getPullRequest

public static Map<String,Object> getPullRequest(String repoOwner,
 String repoName,
 int prNumber)

addLabelToPullRequest

public static Map<String,Object> addLabelToPullRequest(String repoOwner,
 String repoName,
 int prNumber,
 String label)

addCommentToPullRequest

public static Map<String,Object> addCommentToPullRequest(String repoOwner,
 String repoName,
 int prNumber,
 String comment)

addCommentToIssue

public static Map<String,Object> addCommentToIssue(String repoOwner,
 String repoName,
 int issueNumber,
 String body)

closeIssue

public static Map<String,Object> closeIssue(String repoOwner,
 String repoName,
 int issueNumber)