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" or "error". Reads GITHUB_TOKEN from the environment; callers set dryRun to gate writes.

Defense in depth against prompt injection: the agent reads 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) only modify Markdown files under docs/, and (c) are capped per run.

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>	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)
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>	listReleases(String repoOwner, String repoName)
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)

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)