Steps to Use Claude with the GitHub Executable:

  1. Install Claude Desktop:

    Download from https://claude.ai/download

  2. Download the Executable:

    https://github.com/chayan-1906/GitHub-MCP/releases/download/v1.3.0/github

    https://github.com/chayan-1906/GitHub-MCP/releases/download/v1.3.0/github.exe

  3. Run the Executable:

    1. For macOS users —

      • Run the command below in the terminal (inside the folder)
      chmod +x github
      ./github
      
    2. For Windows users:

      • Double-click the file, or
      • Run via terminal: .\\github.exe
  4. (Optional) Explore Available Tools

    Visit the homepage to browse all available tools:

  5. (Optional) Stop the Server:

    You can stop the server if needed.

    Note: This is optional because launching Claude will automatically stop the currently running instance/port.

  6. Launch Claude Desktop

  7. Start Asking Tasks:

    Claude will now recognise the available tools (with descriptions).


🧰 Available Tools

Here is a comprehensive list of available tools, along with their descriptions.

Tool Name Category Description
my-github-account Profile Get your GitHub account information and profile details
list-repositories Repositories List all repositories you have access to with pagination
get-repository-details Repositories Get detailed information about a specific repository
create-repository Repositories Create a new repository in your GitHub account
update-repository Repositories Update repository settings like description and topics
rename-repository Repositories Rename one of your repositories
delete-repository Repositories Permanently delete repository
modify-repository-visibility Repositories Change repository visibility settings
list-collaborators Repositories View all collaborators and pending invitations for a repository
add-remove-collaborators Repositories Invite or remove collaborators from your repository
list-branches Branches List all branches in a repository with pagination support
get-branch-details Branches Get detailed information about a specific branch
create-branch Branches Create a new branch from an existing commit
set-default-branch Branches Set the default branch for a repository
delete-branch Branches Delete a branch from the repository
repository-tree Files Browse repository files and folders in a visual tree structure
get-file-content Files Read the contents of a specific file from a repository
commit-remote-file Files Create or update a file in a repository with a commit
list-commits Commits List commits from a repository branch with pagination
get-commit-modifications Commits View files modified in a specific commit
list-issues Issues List repository issues with filtering and pagination
get-issue-details Issues Get detailed information about a specific issue
get-issue-comments Issues Get all comments and participant details for an issue
create-issue Issues Create a new issue with optional description and labels'
update-issue Issues Update an existing issue\'s title, description, or labels
update-issue-state Issues Open or close an issue
assign-issue Issues Assign users to an issue
list-pull-requests Pull Requests List all pull requests with filtering and pagination
get-pull-request-details Pull Requests Get detailed information about a specific pull request
create-pull-request Pull Requests Create a new pull request between branches
update-pull-request Pull Requests Update an existing pull request\'s details
list-pull-request-commits Pull Requests List all commits in a pull request
list-pull-request-files Pull Requests List all changed files in a pull request with diff details
update-pull-request-state Pull Requests Open or close a pull request
merge-pull-request Pull Requests Merge a pull request (checks for conflicts)
get-pull-request-reviews Pull Requests Get all reviews for a pull request
create-pull-request-review Pull Requests Create a pull request review (approve/request changes/comment)
request-pull-request-review Pull Requests Request reviews from users or teams
dismiss-pull-request-review Pull Requests Dismiss a pull request review
mark-pull-request-review Pull Requests Submit a pending pull request review
list-releases Releases List all releases in a repository with pagination
create-release Releases Create a new release with optional tag creation
update-release Releases Update an existing release with new information
delete-release Releases Permanently delete a release

Important Notes:

Sample Prompts:

  1. Analyse the GitHub repository https://github.com/chayan-1906/Busgo-React-Native using available GitHub tools and provide:
    1. Insights into code structure and activity (commits, issues, pull requests)
    2. A pictorial summary (e.g., architecture diagram or project structure visualisation)
  2. For the repository {username}/legacy-systems, identify all branches that haven't had any commits in the last 6 months and are not the default branch. For each such branch:
    1. Create an issue titled Archive <branch-name> with a short summary
    2. Push the branch name and last commit date to a file named archived-branches.md in a new branch called cleanup-archive
    3. Delete those branches from the remote