uses:docker/metadata-action@96383f45573cb7f253c731d3b3ab81c87ef81934# v5.0.0

with:

images:${{ env.REGISTRY }}/${{ env.IMAGE_NAME }}

tags:|

-name:Go Build Cache for Docker

uses:actions/cache@v4

-"v*"

permissions:

contents:write

id-token:write

attestations:write

jobs:

release:

workdir:.

env:

GITHUB_TOKEN:${{ secrets.GITHUB_TOKEN }}

-name:Generate signed build provenance attestations for workflow artifacts

uses:actions/attest-build-provenance@v2

with:

subject-path:|

[fork]:https://github.com/github/github-mcp-server/fork

[pr]:https://github.com/github/github-mcp-server/compare

[style]:https://github.com/github/github-mcp-server/blob/main/.golangci.yaml

[style]:https://github.com/github/github-mcp-server/blob/main/.golangci.yml

Hi there! We're thrilled that you'd like to contribute to this project. Your help is essential for keeping it great.

1. To run the server in a container, you will need to have[Docker](https://www.docker.com/) installed.

2.[Create a GitHub Personal Access Token](https://github.com/settings/personal-access-tokens/new).

2. Once Docker is installed, you will also need to ensure Docker is running.

3. Lastly you will need to[Create a GitHub Personal Access Token](https://github.com/settings/personal-access-tokens/new).

The MCP server can use many of the GitHub APIs, so enable the permissions that you feel comfortable granting your AI tools (to learn more about access tokens, please check out the[documentation](https://docs.github.com/en/authentication/keeping-your-account-and-data-secure/managing-your-personal-access-tokens)).

-`repo`: Repository name (string, required)

-`issue_number`: Issue number (number, required)

-**get_issue_comments** - Get comments for a GitHub issue

-`owner`: Repository owner (string, required)

-`repo`: Repository name (string, required)

-`issue_number`: Issue number (number, required)

-**create_issue** - Create a new issue in a GitHub repository

-`owner`: Repository owner (string, required)

-`sort`: Sort field (string, optional)

-`order`: Sort order (string, optional)

-`page`: Page number (number, optional)

-`per_page`: Results per page (number, optional)

-`perPage`: Results per page (number, optional)

-`body`: Review comment text (string, optional)

-`event`: Review action ('APPROVE', 'REQUEST_CHANGES', 'COMMENT') (string, required)

-`commitId`: SHA of commit to review (string, optional)

-`comments`: Line-specific comments array of objects, each object with path (string), position (number), and body (string) (array, optional)

-`comments`: Line-specific comments array of objects to place comments on pull request changes (array, optional)

- For inline comments: provide`path`,`position` (or`line`), and`body`

- For multi-line comments: provide`path`,`start_line`,`line`, optional`side`/`start_side`, and`body`

-**create_pull_request** - Create a new pull request

-`draft`: Create as draft PR (boolean, optional)

-`maintainer_can_modify`: Allow maintainer edits (boolean, optional)

-**add_pull_request_review_comment** - Add a review comment to a pull request or reply to an existing comment

-`owner`: Repository owner (string, required)

-`repo`: Repository name (string, required)

-`pull_number`: Pull request number (number, required)

-`body`: The text of the review comment (string, required)

-`commit_id`: The SHA of the commit to comment on (string, required unless using in_reply_to)

-`path`: The relative path to the file that necessitates a comment (string, required unless using in_reply_to)

-`line`: The line of the blob in the pull request diff that the comment applies to (number, optional)

-`side`: The side of the diff to comment on (LEFT or RIGHT) (string, optional)

-`start_line`: For multi-line comments, the first line of the range (number, optional)

-`start_side`: For multi-line comments, the starting side of the diff (LEFT or RIGHT) (string, optional)

-`subject_type`: The level at which the comment is targeted (line or file) (string, optional)

-`in_reply_to`: The ID of the review comment to reply to (number, optional). When specified, only body is required and other parameters are ignored.

-**update_pull_request** - Update an existing pull request in a GitHub repository

-`owner`: Repository owner (string, required)

-`repo`: Repository name (string, required)

-`pullNumber`: Pull request number to update (number, required)

-`title`: New title (string, optional)

-`body`: New description (string, optional)

-`state`: New state ('open' or 'closed') (string, optional)

-`base`: New base branch name (string, optional)

-`maintainer_can_modify`: Allow maintainer edits (boolean, optional)

-**create_or_update_file** - Create or update a single file in a repository

-`branch`: Branch name (string, optional)

-`sha`: File SHA if updating (string, optional)

-**list_branches** - List branches in a GitHub repository

-`owner`: Repository owner (string, required)

-`repo`: Repository name (string, required)

-`page`: Page number (number, optional)

-`perPage`: Results per page (number, optional)

-**push_files** - Push multiple files in a single commit

-`owner`: Repository owner (string, required)

-`branch`: New branch name (string, required)

-`sha`: SHA to create branch from (string, required)

-**list_commits** -Gets commits of a branch in a repository

-**list_commits** -Get a list of commits of a branch in a repository

-`owner`: Repository owner (string, required)

-`repo`: Repository name (string, required)

-`sha`: Branch name, tag, or commit SHA (string, optional)

-`path`: Only commits containing this file path (string, optional)

-`page`: Page number (number, optional)

-`perPage`: Results per page (number, optional)

-**get_commit** - Get details for a commit from a repository

-`owner`: Repository owner (string, required)

-`repo`: Repository name (string, required)

-`sha`: Commit SHA, branch name, or tag name (string, required)

-`page`: Page number, for files in the commit (number, optional)

-`perPage`: Results per page, for files in the commit (number, optional)

-**search_code** - Search for code across GitHub repositories

-`prNumber`: Pull request number (string, required)

-`path`: File or directory path (string, optional)

The exported Go API of this module should currently be considered unstable, and subject to breaking changes. In the future, we may offer stability; please file an issue if there is a use case where this would be valuable.

This project is licensed under the terms of the MIT open source license. Please refer to[MIT](./LICENSE) for the full terms.

package main

import (

stdlog"log"

iolog"github.com/github/github-mcp-server/pkg/log"

gogithub"github.com/google/go-github/v69/github"

log"github.com/sirupsen/logrus"

logFile:=viper.GetString("log-file")

readOnly:=viper.GetBool("read-only")

exportTranslations:=viper.GetBool("export-translations")

prettyPrintJSON:=viper.GetBool("pretty-print-json")

logger,err:=initLogger(logFile)

iferr!=nil {

stdlog.Fatal("Failed to initialize logger:",err)

logger:logger,

logCommands:logCommands,

exportTranslations:exportTranslations,

prettyPrintJSON:prettyPrintJSON,

}

iferr:=runStdioServer(cfg);err!=nil {

stdlog.Fatal("failed to run stdio server:",err)

rootCmd.PersistentFlags().Bool("enable-command-logging",false,"When enabled, the server will log all command requests and responses to the log file")

rootCmd.PersistentFlags().Bool("export-translations",false,"Save translations to a JSON file")

rootCmd.PersistentFlags().String("gh-host","","Specify the GitHub hostname (for GitHub Enterprise etc.)")

rootCmd.PersistentFlags().Bool("pretty-print-json",false,"Pretty print JSON output")

_=viper.BindPFlag("read-only",rootCmd.PersistentFlags().Lookup("read-only"))

_=viper.BindPFlag("log-file",rootCmd.PersistentFlags().Lookup("log-file"))

_=viper.BindPFlag("enable-command-logging",rootCmd.PersistentFlags().Lookup("enable-command-logging"))

_=viper.BindPFlag("export-translations",rootCmd.PersistentFlags().Lookup("export-translations"))

_=viper.BindPFlag("gh-host",rootCmd.PersistentFlags().Lookup("gh-host"))

_=viper.BindPFlag("pretty-print-json",rootCmd.PersistentFlags().Lookup("pretty-print-json"))

rootCmd.AddCommand(stdioCmd)

logger*log.Logger

}

typeJSONPrettyPrintWriterstruct {

writer io.Writer

}

func (jJSONPrettyPrintWriter)Write(p []byte) (nint,errerror) {

varprettyJSON bytes.Buffer

iferr:=json.Indent(&prettyJSON,p,"","\t");err!=nil {

return0,err

}

returnj.writer.Write(prettyJSON.Bytes())

}

funcrunStdioServer(cfgrunConfig)error {

t,dumpTranslations:=translations.TranslationHelper()

beforeInit:=func(_ context.Context,_any,message*mcp.InitializeRequest) {

ghClient.UserAgent=fmt.Sprintf("github-mcp-server/%s (%s/%s)",version,message.Params.ClientInfo.Name,message.Params.ClientInfo.Version)

}

getClient:=func(_ context.Context) (*gogithub.Client,error) {

returnghClient,nil// closing over client

}

hooks:=&server.Hooks{

OnBeforeInitialize: []server.OnBeforeInitializeFunc{beforeInit},

}

ghServer:=github.NewServer(ghClient,cfg.readOnly,t)

ghServer:=github.NewServer(getClient,version,cfg.readOnly,t,server.WithHooks(hooks))

stdioServer:=server.NewStdioServer(ghServer)

stdLogger:=stdlog.New(cfg.logger.Writer(),"stdioserver",0)

in,out=loggedIO,loggedIO

}

ifcfg.prettyPrintJSON {

out=JSONPrettyPrintWriter{writer:out}

}

errC<-stdioServer.Listen(ctx,in,out)

}()

create_repository Create a new GitHub repositoryin your account

fork_repository Fork a GitHub repository to your account or specified organization

get_file_contents Get the contents of a file or directory from a GitHub repository

get_issue Get details of a specific issuein a GitHub repository.

get_issue Get details of a specific issuein a GitHub repository

get_issue_comments Get commentsfor a GitHub issue

list_commits Get list of commits of a branchin a GitHub repository

list_issues List issuesin a GitHub repository with filtering options

push_files Push multiple files to a GitHub repositoryin a single commit

% ./mcpcurl --stdio-server-cmd"docker run -i --rm -e GITHUB_PERSONAL_ACCESS_TOKEN mcp/github" tools get_issue --help

Get details of a specific issuein a GitHub repository.

Get details of a specific issuein a GitHub repository

Usage:

mcpcurl tools get_issue [flags]

import (

)

_=rootCmd.MarkPersistentFlagRequired("stdio-server-cmd")

rootCmd.PersistentFlags().Bool("pretty",true,"Pretty print MCP response (only for JSON responses)")

rootCmd.PersistentFlags().Bool("pretty",true,"Pretty print MCP response (only for JSONor JSONLresponses)")

rootCmd.AddCommand(toolsCmd)

for_,content:=rangeresp.Result.Content {

ifcontent.Type=="text" {

vartextContentmap[string]interface{}

iferr:=json.Unmarshal([]byte(content.Text),&textContent);err!=nil {

returnfmt.Errorf("failed to parse text content: %w",err)

vartextContentObjmap[string]interface{}

err:=json.Unmarshal([]byte(content.Text),&textContentObj)

iferr==nil {

prettyText,err:=json.MarshalIndent(textContentObj,""," ")

iferr!=nil {

returnfmt.Errorf("failed to pretty print text content: %w",err)

}

fmt.Println(string(prettyText))

}

vartextContentList []map[string]interface{}

iferr:=json.Unmarshal([]byte(content.Text),&textContentList);err!=nil {

returnfmt.Errorf("failed to parse text content as a list: %w",err)

}

prettyText,err:=json.MarshalIndent(textContent,""," ")

prettyText,err:=json.MarshalIndent(textContentList,""," ")

iferr!=nil {

returnfmt.Errorf("failed to pretty printtext content: %w",err)

returnfmt.Errorf("failed to pretty printarray content: %w",err)

}

fmt.Println(string(prettyText))

}

require (

github.com/Azure/go-ansitermv0.0.0-20210617225240-d185dfc1b5a1/go.mod h1:xomTg63KZ2rFqZQzSB4Vz2SUXa1BpHTVz9L5PTmPC4E=

github.com/Microsoft/go-winiov0.6.2 h1:F2VQgta7ecxGYO8k3ZZz3RS8fVIXVxONVUPlNERoyfY=

github.com/Microsoft/go-winiov0.6.2/go.mod h1:yd8OoFMLzJbo9gZq8j5qaps8bJ9aShtEA8Ipt1oGCvU=

github.com/aws/smithy-gov1.22.3 h1:Z//5NuZCSW6R4PhQ93hShNbyBbn8BWCmCVCt+Q8Io5k=

github.com/aws/smithy-gov1.22.3/go.mod h1:t1ufH5HMublsJYulve2RKmHDC15xu1f26kHCp/HgceI=

github.com/cenkalti/backoff/v4v4.2.1 h1:y4OZtCnogmCPw98Zjyt5a6+QwPLGkiQsYW5oUqylYbM=

github.com/cenkalti/backoff/v4v4.2.1/go.mod h1:Y3VNntkOUPxTVeUxJ/G5vcM//AlwfmyYozVcomhLiZE=

github.com/containerd/logv0.1.0 h1:TCJt7ioM2cr/tfR8GPbGf9/VRAX8D2B4PjzCpfX540I=