github

package
v0.4.0 Latest Latest
Warning

This package is not in the latest version of its module.

 Go to latest Published: May 23, 2025 License: MIT Imports: 19 Imported by: 1

Documentation

Index

Constants

View Source 
const (
	FilterDefault           = "default"
	FilterIncludeRead       = "include_read_notifications"
	FilterOnlyParticipating = "only_participating"
)
View Source 
const (
	NotificationActionIgnore = "ignore"
	NotificationActionWatch  = "watch"
	NotificationActionDelete = "delete"
)

Enum values for ManageNotificationSubscription action

View Source 
const (
	RepositorySubscriptionActionWatch  = "watch"
	RepositorySubscriptionActionIgnore = "ignore"
	RepositorySubscriptionActionDelete = "delete"
)

Variables

View Source 
var DefaultTools = []string{"all"}

Functions

func AddIssueComment added in v0.2.0 

func AddIssueComment(getClient GetClientFn, t translations.TranslationHelperFunc) (tool mcp.Tool, handler server.ToolHandlerFunc)

AddIssueComment creates a tool to add a comment to an issue.

func AddPullRequestReviewCommentToPendingReview added in v0.4.0 

func AddPullRequestReviewCommentToPendingReview(getGQLClient GetGQLClientFn, t translations.TranslationHelperFunc) (mcp.Tool, server.ToolHandlerFunc)

AddPullRequestReviewCommentToPendingReview creates a tool to add a comment to a pull request review.

func AssignCopilotToIssue added in v0.4.0 

func AssignCopilotToIssue(getGQLClient GetGQLClientFn, t translations.TranslationHelperFunc) (mcp.Tool, server.ToolHandlerFunc)

func CreateAndSubmitPullRequestReview added in v0.4.0 

func CreateAndSubmitPullRequestReview(getGQLClient GetGQLClientFn, t translations.TranslationHelperFunc) (mcp.Tool, server.ToolHandlerFunc)

func CreateBranch added in v0.2.0 

func CreateBranch(getClient GetClientFn, t translations.TranslationHelperFunc) (tool mcp.Tool, handler server.ToolHandlerFunc)

CreateBranch creates a tool to create a new branch.

func CreateIssue added in v0.2.0 

func CreateIssue(getClient GetClientFn, t translations.TranslationHelperFunc) (tool mcp.Tool, handler server.ToolHandlerFunc)

CreateIssue creates a tool to create a new issue in a GitHub repository.

func CreateOrUpdateFile added in v0.2.0 

func CreateOrUpdateFile(getClient GetClientFn, t translations.TranslationHelperFunc) (tool mcp.Tool, handler server.ToolHandlerFunc)

CreateOrUpdateFile creates a tool to create or update a file in a GitHub repository.

func CreatePendingPullRequestReview added in v0.4.0 

func CreatePendingPullRequestReview(getGQLClient GetGQLClientFn, t translations.TranslationHelperFunc) (mcp.Tool, server.ToolHandlerFunc)

CreatePendingPullRequestReview creates a tool to create a pending review on a pull request.

func CreatePullRequest added in v0.2.0 

func CreatePullRequest(getClient GetClientFn, t translations.TranslationHelperFunc) (mcp.Tool, server.ToolHandlerFunc)

CreatePullRequest creates a tool to create a new pull request.

func CreateRepository added in v0.2.0 

func CreateRepository(getClient GetClientFn, t translations.TranslationHelperFunc) (tool mcp.Tool, handler server.ToolHandlerFunc)

CreateRepository creates a tool to create a new GitHub repository.

func DeleteFile added in v0.3.0 

func DeleteFile(getClient GetClientFn, t translations.TranslationHelperFunc) (tool mcp.Tool, handler server.ToolHandlerFunc)

DeleteFile creates a tool to delete a file in a GitHub repository. This tool uses a more roundabout way of deleting a file than just using the client.Repositories.DeleteFile. This is because REST file deletion endpoint (and client.Repositories.DeleteFile) don't add commit signing to the deletion commit, unlike how the endpoint backing the create_or_update_files tool does. This appears to be a quirk of the API. The approach implemented here gets automatic commit signing when used with either the github-actions user or as an app, both of which suit an LLM well.

func DeletePendingPullRequestReview added in v0.4.0 

func DeletePendingPullRequestReview(getGQLClient GetGQLClientFn, t translations.TranslationHelperFunc) (mcp.Tool, server.ToolHandlerFunc)

func DismissNotification added in v0.4.0 

func DismissNotification(getclient GetClientFn, t translations.TranslationHelperFunc) (tool mcp.Tool, handler server.ToolHandlerFunc)

DismissNotification creates a tool to mark a notification as read/done.

func EnableToolset added in v0.2.0 

func EnableToolset(s *server.MCPServer, toolsetGroup *toolsets.ToolsetGroup, t translations.TranslationHelperFunc) (tool mcp.Tool, handler server.ToolHandlerFunc)

func ForkRepository added in v0.2.0 

func ForkRepository(getClient GetClientFn, t translations.TranslationHelperFunc) (tool mcp.Tool, handler server.ToolHandlerFunc)

ForkRepository creates a tool to fork a repository.

func GetCodeScanningAlert added in v0.2.0 

func GetCodeScanningAlert(getClient GetClientFn, t translations.TranslationHelperFunc) (tool mcp.Tool, handler server.ToolHandlerFunc)

func GetCommit added in v0.2.0 

func GetCommit(getClient GetClientFn, t translations.TranslationHelperFunc) (tool mcp.Tool, handler server.ToolHandlerFunc)

func GetFileContents added in v0.2.0 

func GetFileContents(getClient GetClientFn, t translations.TranslationHelperFunc) (tool mcp.Tool, handler server.ToolHandlerFunc)

GetFileContents creates a tool to get the contents of a file or directory from a GitHub repository.

func GetIssue added in v0.2.0 

func GetIssue(getClient GetClientFn, t translations.TranslationHelperFunc) (tool mcp.Tool, handler server.ToolHandlerFunc)

GetIssue creates a tool to get details of a specific issue in a GitHub repository.

func GetIssueComments added in v0.2.0 

func GetIssueComments(getClient GetClientFn, t translations.TranslationHelperFunc) (tool mcp.Tool, handler server.ToolHandlerFunc)

GetIssueComments creates a tool to get comments for a GitHub issue.

func GetMe added in v0.2.0 

func GetMe(getClient GetClientFn, t translations.TranslationHelperFunc) (tool mcp.Tool, handler server.ToolHandlerFunc)

GetMe creates a tool to get details of the authenticated user.

func GetNotificationDetails added in v0.4.0 

func GetNotificationDetails(getClient GetClientFn, t translations.TranslationHelperFunc) (tool mcp.Tool, handler server.ToolHandlerFunc)

GetNotificationDetails creates a tool to get details for a specific notification.

func GetPullRequest added in v0.2.0 

func GetPullRequest(getClient GetClientFn, t translations.TranslationHelperFunc) (mcp.Tool, server.ToolHandlerFunc)

GetPullRequest creates a tool to get details of a specific pull request.

func GetPullRequestComments added in v0.2.0 

func GetPullRequestComments(getClient GetClientFn, t translations.TranslationHelperFunc) (mcp.Tool, server.ToolHandlerFunc)

GetPullRequestComments creates a tool to get the review comments on a pull request.

func GetPullRequestDiff added in v0.4.0 

func GetPullRequestDiff(getClient GetClientFn, t translations.TranslationHelperFunc) (mcp.Tool, server.ToolHandlerFunc)

func GetPullRequestFiles added in v0.2.0 

func GetPullRequestFiles(getClient GetClientFn, t translations.TranslationHelperFunc) (mcp.Tool, server.ToolHandlerFunc)

GetPullRequestFiles creates a tool to get the list of files changed in a pull request.

func GetPullRequestReviews added in v0.2.0 

func GetPullRequestReviews(getClient GetClientFn, t translations.TranslationHelperFunc) (mcp.Tool, server.ToolHandlerFunc)

GetPullRequestReviews creates a tool to get the reviews on a pull request.

func GetPullRequestStatus added in v0.2.0 

func GetPullRequestStatus(getClient GetClientFn, t translations.TranslationHelperFunc) (mcp.Tool, server.ToolHandlerFunc)

GetPullRequestStatus creates a tool to get the combined status of all status checks for a pull request.

func GetRepositoryResourceBranchContent added in v0.2.0 

func GetRepositoryResourceBranchContent(getClient GetClientFn, t translations.TranslationHelperFunc) (mcp.ResourceTemplate, server.ResourceTemplateHandlerFunc)

GetRepositoryResourceBranchContent defines the resource template and handler for getting repository content for a branch.

func GetRepositoryResourceCommitContent added in v0.2.0 

func GetRepositoryResourceCommitContent(getClient GetClientFn, t translations.TranslationHelperFunc) (mcp.ResourceTemplate, server.ResourceTemplateHandlerFunc)

GetRepositoryResourceCommitContent defines the resource template and handler for getting repository content for a commit.

func GetRepositoryResourceContent added in v0.2.0 

func GetRepositoryResourceContent(getClient GetClientFn, t translations.TranslationHelperFunc) (mcp.ResourceTemplate, server.ResourceTemplateHandlerFunc)

GetRepositoryResourceContent defines the resource template and handler for getting repository content.

func GetRepositoryResourcePrContent added in v0.2.0 

func GetRepositoryResourcePrContent(getClient GetClientFn, t translations.TranslationHelperFunc) (mcp.ResourceTemplate, server.ResourceTemplateHandlerFunc)

GetRepositoryResourcePrContent defines the resource template and handler for getting repository content for a pull request.

func GetRepositoryResourceTagContent added in v0.2.0 

func GetRepositoryResourceTagContent(getClient GetClientFn, t translations.TranslationHelperFunc) (mcp.ResourceTemplate, server.ResourceTemplateHandlerFunc)

GetRepositoryResourceTagContent defines the resource template and handler for getting repository content for a tag.

func GetSecretScanningAlert added in v0.2.0 

func GetSecretScanningAlert(getClient GetClientFn, t translations.TranslationHelperFunc) (tool mcp.Tool, handler server.ToolHandlerFunc)

func GetTag added in v0.3.0 

func GetTag(getClient GetClientFn, t translations.TranslationHelperFunc) (tool mcp.Tool, handler server.ToolHandlerFunc)

GetTag creates a tool to get details about a specific tag in a GitHub repository.

func GetToolsetsTools added in v0.2.0 

func GetToolsetsTools(toolsetGroup *toolsets.ToolsetGroup, t translations.TranslationHelperFunc) (tool mcp.Tool, handler server.ToolHandlerFunc)

func InitContextToolset added in v0.2.0 

func InitContextToolset(getClient GetClientFn, t translations.TranslationHelperFunc) *toolsets.Toolset

func InitDynamicToolset added in v0.2.0 

func InitDynamicToolset(s *server.MCPServer, tsg *toolsets.ToolsetGroup, t translations.TranslationHelperFunc) *toolsets.Toolset

InitDynamicToolset creates a dynamic toolset that can be used to enable other toolsets, and so requires the server and toolset group as arguments

func InitToolsets added in v0.2.0 

func InitToolsets(passedToolsets []string, readOnly bool, getClient GetClientFn, getGQLClient GetGQLClientFn, t translations.TranslationHelperFunc) (*toolsets.ToolsetGroup, error)

func ListAvailableToolsets added in v0.2.0 

func ListAvailableToolsets(toolsetGroup *toolsets.ToolsetGroup, t translations.TranslationHelperFunc) (tool mcp.Tool, handler server.ToolHandlerFunc)

func ListBranches added in v0.2.0 

func ListBranches(getClient GetClientFn, t translations.TranslationHelperFunc) (tool mcp.Tool, handler server.ToolHandlerFunc)

ListBranches creates a tool to list branches in a GitHub repository.

func ListCodeScanningAlerts added in v0.2.0 

func ListCodeScanningAlerts(getClient GetClientFn, t translations.TranslationHelperFunc) (tool mcp.Tool, handler server.ToolHandlerFunc)

func ListCommits added in v0.2.0 

func ListCommits(getClient GetClientFn, t translations.TranslationHelperFunc) (tool mcp.Tool, handler server.ToolHandlerFunc)

ListCommits creates a tool to get commits of a branch in a repository.

func ListIssues added in v0.2.0 

func ListIssues(getClient GetClientFn, t translations.TranslationHelperFunc) (tool mcp.Tool, handler server.ToolHandlerFunc)

ListIssues creates a tool to list and filter repository issues

func ListNotifications added in v0.4.0 

func ListNotifications(getClient GetClientFn, t translations.TranslationHelperFunc) (tool mcp.Tool, handler server.ToolHandlerFunc)

ListNotifications creates a tool to list notifications for the current user.

func ListPullRequests added in v0.2.0 

func ListPullRequests(getClient GetClientFn, t translations.TranslationHelperFunc) (mcp.Tool, server.ToolHandlerFunc)

ListPullRequests creates a tool to list and filter repository pull requests.

func ListSecretScanningAlerts added in v0.2.0 

func ListSecretScanningAlerts(getClient GetClientFn, t translations.TranslationHelperFunc) (tool mcp.Tool, handler server.ToolHandlerFunc)

func ListTags added in v0.3.0 

func ListTags(getClient GetClientFn, t translations.TranslationHelperFunc) (tool mcp.Tool, handler server.ToolHandlerFunc)

ListTags creates a tool to list tags in a GitHub repository.

func ManageNotificationSubscription added in v0.4.0 

func ManageNotificationSubscription(getClient GetClientFn, t translations.TranslationHelperFunc) (tool mcp.Tool, handler server.ToolHandlerFunc)

ManageNotificationSubscription creates a tool to manage a notification subscription (ignore, watch, delete)

func ManageRepositoryNotificationSubscription added in v0.4.0 

func ManageRepositoryNotificationSubscription(getClient GetClientFn, t translations.TranslationHelperFunc) (tool mcp.Tool, handler server.ToolHandlerFunc)

ManageRepositoryNotificationSubscription creates a tool to manage a repository notification subscription (ignore, watch, delete)

func MarkAllNotificationsRead added in v0.4.0 

func MarkAllNotificationsRead(getClient GetClientFn, t translations.TranslationHelperFunc) (tool mcp.Tool, handler server.ToolHandlerFunc)

MarkAllNotificationsRead creates a tool to mark all notifications as read.

func MergePullRequest added in v0.2.0 

func MergePullRequest(getClient GetClientFn, t translations.TranslationHelperFunc) (mcp.Tool, server.ToolHandlerFunc)

MergePullRequest creates a tool to merge a pull request.

func NewServer 

func NewServer(version string, opts ...server.ServerOption) *server.MCPServer

func OptionalIntParam added in v0.2.0 

func OptionalIntParam(r mcp.CallToolRequest, p string) (int, error)

OptionalIntParam is a helper function that can be used to fetch a requested parameter from the request. It does the following checks: 1. Checks if the parameter is present in the request, if not, it returns its zero-value 2. If it is present, it checks if the parameter is of the expected type and returns it

func OptionalIntParamWithDefault added in v0.2.0 

func OptionalIntParamWithDefault(r mcp.CallToolRequest, p string, d int) (int, error)

OptionalIntParamWithDefault is a helper function that can be used to fetch a requested parameter from the request similar to optionalIntParam, but it also takes a default value.

func OptionalParam added in v0.2.0 

func OptionalParam[T any](r mcp.CallToolRequest, p string) (T, error)

OptionalParam is a helper function that can be used to fetch a requested parameter from the request. It does the following checks: 1. Checks if the parameter is present in the request, if not, it returns its zero-value 2. If it is present, it checks if the parameter is of the expected type and returns it

func OptionalParamOK added in v0.2.0 

func OptionalParamOK[T any](r mcp.CallToolRequest, p string) (value T, ok bool, err error)

OptionalParamOK is a helper function that can be used to fetch a requested parameter from the request. It returns the value, a boolean indicating if the parameter was present, and an error if the type is wrong.

func OptionalStringArrayParam added in v0.2.0 

func OptionalStringArrayParam(r mcp.CallToolRequest, p string) ([]string, error)

OptionalStringArrayParam is a helper function that can be used to fetch a requested parameter from the request. It does the following checks: 1. Checks if the parameter is present in the request, if not, it returns its zero-value 2. If it is present, iterates the elements and checks each is a string

func PushFiles added in v0.2.0 

func PushFiles(getClient GetClientFn, t translations.TranslationHelperFunc) (tool mcp.Tool, handler server.ToolHandlerFunc)

PushFiles creates a tool to push multiple files in a single commit to a GitHub repository.

func RegisterResources added in v0.2.0 

func RegisterResources(s *server.MCPServer, getClient GetClientFn, t translations.TranslationHelperFunc)

func RepositoryResourceContentsHandler added in v0.2.0 

func RepositoryResourceContentsHandler(getClient GetClientFn) func(ctx context.Context, request mcp.ReadResourceRequest) ([]mcp.ResourceContents, error)

RepositoryResourceContentsHandler returns a handler function for repository content requests.

func RequestCopilotReview added in v0.3.0 

func RequestCopilotReview(getClient GetClientFn, t translations.TranslationHelperFunc) (mcp.Tool, server.ToolHandlerFunc)

RequestCopilotReview creates a tool to request a Copilot review for a pull request. Note that this tool will not work on GHES where this feature is unsupported. In future, we should not expose this tool if the configured host does not support it.

func RequiredInt added in v0.2.0 

func RequiredInt(r mcp.CallToolRequest, p string) (int, error)

RequiredInt is a helper function that can be used to fetch a requested parameter from the request. It does the following checks: 1. Checks if the parameter is present in the request. 2. Checks if the parameter is of the expected type. 3. Checks if the parameter is not empty, i.e: non-zero value

func SearchCode added in v0.2.0 

func SearchCode(getClient GetClientFn, t translations.TranslationHelperFunc) (tool mcp.Tool, handler server.ToolHandlerFunc)

SearchCode creates a tool to search for code across GitHub repositories.

func SearchIssues added in v0.2.0 

func SearchIssues(getClient GetClientFn, t translations.TranslationHelperFunc) (tool mcp.Tool, handler server.ToolHandlerFunc)

SearchIssues creates a tool to search for issues and pull requests.

func SearchRepositories added in v0.2.0 

func SearchRepositories(getClient GetClientFn, t translations.TranslationHelperFunc) (tool mcp.Tool, handler server.ToolHandlerFunc)

SearchRepositories creates a tool to search for GitHub repositories.

func SearchUsers added in v0.2.0 

func SearchUsers(getClient GetClientFn, t translations.TranslationHelperFunc) (tool mcp.Tool, handler server.ToolHandlerFunc)

SearchUsers creates a tool to search for GitHub users.

func SubmitPendingPullRequestReview added in v0.4.0 

func SubmitPendingPullRequestReview(getGQLClient GetGQLClientFn, t translations.TranslationHelperFunc) (mcp.Tool, server.ToolHandlerFunc)

SubmitPendingPullRequestReview creates a tool to submit a pull request review.

func ToolsetEnum added in v0.2.0 

func ToolsetEnum(toolsetGroup *toolsets.ToolsetGroup) mcp.PropertyOption

func UpdateIssue added in v0.2.0 

func UpdateIssue(getClient GetClientFn, t translations.TranslationHelperFunc) (tool mcp.Tool, handler server.ToolHandlerFunc)

UpdateIssue creates a tool to update an existing issue in a GitHub repository.

func UpdatePullRequest added in v0.2.0 

func UpdatePullRequest(getClient GetClientFn, t translations.TranslationHelperFunc) (mcp.Tool, server.ToolHandlerFunc)

UpdatePullRequest creates a tool to update an existing pull request.

func UpdatePullRequestBranch added in v0.2.0 

func UpdatePullRequestBranch(getClient GetClientFn, t translations.TranslationHelperFunc) (mcp.Tool, server.ToolHandlerFunc)

UpdatePullRequestBranch creates a tool to update a pull request branch with the latest changes from the base branch.

func WithPagination added in v0.2.0 

func WithPagination() mcp.ToolOption

WithPagination returns a ToolOption that adds "page" and "perPage" parameters to the tool. The "page" parameter is optional, min 1. The "perPage" parameter is optional, min 1, max 100.

Types

type GetClientFn added in v0.2.0 

type GetClientFn func(context.Context) (*github.Client, error)

type GetGQLClientFn added in v0.4.0 

type GetGQLClientFn func(context.Context) (*githubv4.Client, error)

type PaginationParams added in v0.2.0 

type PaginationParams struct {
	// contains filtered or unexported fields
}

func OptionalPaginationParams added in v0.2.0 

func OptionalPaginationParams(r mcp.CallToolRequest) (PaginationParams, error)

OptionalPaginationParams returns the "page" and "perPage" parameters from the request, or their default values if not present, "page" default is 1, "perPage" default is 30. In future, we may want to make the default values configurable, or even have this function returned from `withPagination`, where the defaults are provided alongside the min/max values.

type ReplaceActorsForAssignableInput added in v0.4.0 

type ReplaceActorsForAssignableInput struct {
	AssignableID githubv4.ID   `json:"assignableId"`
	ActorIDs     []githubv4.ID `json:"actorIds"`
}

Source Files

View all Source files

Jump to

Keyboard shortcuts

? : This menu
/ : Search site
f or F : Jump to
y or Y : Canonical URL
go.dev uses cookies from Google to deliver and enhance the quality of its services and to analyze traffic. Learn more.