From 5df883d5605ce66eed17f9153496c349063400e6 Mon Sep 17 00:00:00 2001 From: tommaso-moro Date: Thu, 9 Oct 2025 16:13:02 +0100 Subject: [PATCH 1/8] update readme --- README.md | 7 +++++++ 1 file changed, 7 insertions(+) diff --git a/README.md b/README.md index d4806fb84..23d53b75a 100644 --- a/README.md +++ b/README.md @@ -1160,6 +1160,13 @@ Possible options: - **list_copilot_spaces** - List Copilot Spaces +
+Web Search + +- **web_search** - Web Search + - `query`: A natural language query representing what to search for on the web. (string, required) +
+ ## Dynamic Tool Discovery **Note**: This feature is currently in beta and may not be available in all environments. Please test it out and let us know if you encounter any issues. From f2d07d5c3e5ff6d84a243342409dd31d20eb80fd Mon Sep 17 00:00:00 2001 From: tommaso-moro Date: Thu, 9 Oct 2025 18:28:09 +0100 Subject: [PATCH 2/8] update --- README.md | 195 ++++++++++++++++++++++++++++++++++++++++-------------- 1 file changed, 146 insertions(+), 49 deletions(-) diff --git a/README.md b/README.md index 23d53b75a..6cc032de6 100644 --- a/README.md +++ b/README.md @@ -78,6 +78,7 @@ Alternatively, to manually configure VS Code, choose the appropriate JSON block ### Install in other MCP hosts + - **[GitHub Copilot in other IDEs](/docs/installation-guides/install-other-copilot-ides.md)** - Installation for JetBrains, Visual Studio, Eclipse, and Xcode with GitHub Copilot - **[Claude Applications](/docs/installation-guides/install-claude.md)** - Installation guide for Claude Web, Claude Desktop and Claude Code CLI - **[Cursor](/docs/installation-guides/install-cursor.md)** - Installation guide for Cursor IDE @@ -90,6 +91,7 @@ Alternatively, to manually configure VS Code, choose the appropriate JSON block #### Default toolset configuration The default configuration is: + - context - repos - issues @@ -109,29 +111,35 @@ See [Remote Server Documentation](docs/remote-server.md) for full details on rem 1. To run the server in a container, you will need to have [Docker](https://www.docker.com/) installed. 2. Once Docker is installed, you will also need to ensure Docker is running. The image is public; if you get errors on pull, you may have an expired token and need to `docker logout ghcr.io`. 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)). + 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)).
Handling PATs Securely ### Environment Variables (Recommended) + To keep your GitHub PAT secure and reusable across different MCP hosts: 1. **Store your PAT in environment variables** + ```bash export GITHUB_PAT=your_token_here ``` + Or create a `.env` file: + ```env GITHUB_PAT=your_token_here ``` 2. **Protect your `.env` file** + ```bash # Add to .gitignore to prevent accidental commits echo ".env" >> .gitignore ``` 3. **Reference the token in configurations** + ```bash # CLI usage claude mcp update github -e GITHUB_PERSONAL_ACCESS_TOKEN=$GITHUB_PAT @@ -330,26 +338,28 @@ GITHUB_TOOLSETS="all" ./github-mcp-server The following sets of tools are available (all are on by default): -| Toolset | Description | -| ----------------------- | ------------------------------------------------------------- | -| `context` | **Strongly recommended**: Tools that provide context about the current user and GitHub context you are operating in | -| `actions` | GitHub Actions workflows and CI/CD operations | -| `code_security` | Code security related tools, such as GitHub Code Scanning | -| `dependabot` | Dependabot tools | -| `discussions` | GitHub Discussions related tools | -| `experiments` | Experimental features that are not considered stable yet | -| `gists` | GitHub Gist related tools | -| `issues` | GitHub Issues related tools | -| `labels` | GitHub Labels related tools | -| `notifications` | GitHub Notifications related tools | -| `orgs` | GitHub Organization related tools | -| `projects` | GitHub Projects related tools | -| `pull_requests` | GitHub Pull Request related tools | -| `repos` | GitHub Repository related tools | -| `secret_protection` | Secret protection related tools, such as GitHub Secret Scanning | -| `security_advisories` | Security advisories related tools | -| `stargazers` | GitHub Stargazers related tools | -| `users` | GitHub User related tools | + +| Toolset | Description | +| --------------------- | ------------------------------------------------------------------------------------------------------------------- | +| `context` | **Strongly recommended**: Tools that provide context about the current user and GitHub context you are operating in | +| `actions` | GitHub Actions workflows and CI/CD operations | +| `code_security` | Code security related tools, such as GitHub Code Scanning | +| `dependabot` | Dependabot tools | +| `discussions` | GitHub Discussions related tools | +| `experiments` | Experimental features that are not considered stable yet | +| `gists` | GitHub Gist related tools | +| `issues` | GitHub Issues related tools | +| `labels` | GitHub Labels related tools | +| `notifications` | GitHub Notifications related tools | +| `orgs` | GitHub Organization related tools | +| `projects` | GitHub Projects related tools | +| `pull_requests` | GitHub Pull Request related tools | +| `repos` | GitHub Repository related tools | +| `secret_protection` | Secret protection related tools, such as GitHub Secret Scanning | +| `security_advisories` | Security advisories related tools | +| `stargazers` | GitHub Stargazers related tools | +| `users` | GitHub User related tools | + ## Tools @@ -360,21 +370,25 @@ The following sets of tools are available (all are on by default): Actions - **cancel_workflow_run** - Cancel workflow run + - `owner`: Repository owner (string, required) - `repo`: Repository name (string, required) - `run_id`: The unique identifier of the workflow run (number, required) - **delete_workflow_run_logs** - Delete workflow logs + - `owner`: Repository owner (string, required) - `repo`: Repository name (string, required) - `run_id`: The unique identifier of the workflow run (number, required) - **download_workflow_run_artifact** - Download workflow artifact + - `artifact_id`: The unique identifier of the artifact (number, required) - `owner`: Repository owner (string, required) - `repo`: Repository name (string, required) - **get_job_logs** - Get job logs + - `failed_only`: When true, gets logs for all failed jobs in run_id (boolean, optional) - `job_id`: The unique identifier of the workflow job (required for single job logs) (number, optional) - `owner`: Repository owner (string, required) @@ -384,21 +398,25 @@ The following sets of tools are available (all are on by default): - `tail_lines`: Number of lines to return from the end of the log (number, optional) - **get_workflow_run** - Get workflow run + - `owner`: Repository owner (string, required) - `repo`: Repository name (string, required) - `run_id`: The unique identifier of the workflow run (number, required) - **get_workflow_run_logs** - Get workflow run logs + - `owner`: Repository owner (string, required) - `repo`: Repository name (string, required) - `run_id`: The unique identifier of the workflow run (number, required) - **get_workflow_run_usage** - Get workflow usage + - `owner`: Repository owner (string, required) - `repo`: Repository name (string, required) - `run_id`: The unique identifier of the workflow run (number, required) - **list_workflow_jobs** - List workflow jobs + - `filter`: Filters jobs by their completed_at timestamp (string, optional) - `owner`: Repository owner (string, required) - `page`: Page number for pagination (min 1) (number, optional) @@ -407,6 +425,7 @@ The following sets of tools are available (all are on by default): - `run_id`: The unique identifier of the workflow run (number, required) - **list_workflow_run_artifacts** - List workflow artifacts + - `owner`: Repository owner (string, required) - `page`: Page number for pagination (min 1) (number, optional) - `perPage`: Results per page for pagination (min 1, max 100) (number, optional) @@ -414,6 +433,7 @@ The following sets of tools are available (all are on by default): - `run_id`: The unique identifier of the workflow run (number, required) - **list_workflow_runs** - List workflow runs + - `actor`: Returns someone's workflow runs. Use the login for the user who created the workflow run. (string, optional) - `branch`: Returns workflow runs associated with a branch. Use the name of the branch. (string, optional) - `event`: Returns workflow runs for a specific event type (string, optional) @@ -425,17 +445,20 @@ The following sets of tools are available (all are on by default): - `workflow_id`: The workflow ID or workflow file name (string, required) - **list_workflows** - List workflows + - `owner`: Repository owner (string, required) - `page`: Page number for pagination (min 1) (number, optional) - `perPage`: Results per page for pagination (min 1, max 100) (number, optional) - `repo`: Repository name (string, required) - **rerun_failed_jobs** - Rerun failed jobs + - `owner`: Repository owner (string, required) - `repo`: Repository name (string, required) - `run_id`: The unique identifier of the workflow run (number, required) - **rerun_workflow_run** - Rerun workflow run + - `owner`: Repository owner (string, required) - `repo`: Repository name (string, required) - `run_id`: The unique identifier of the workflow run (number, required) @@ -454,6 +477,7 @@ The following sets of tools are available (all are on by default): Code Security - **get_code_scanning_alert** - Get code scanning alert + - `alertNumber`: The number of the alert. (number, required) - `owner`: The owner of the repository. (string, required) - `repo`: The name of the repository. (string, required) @@ -473,9 +497,11 @@ The following sets of tools are available (all are on by default): Context - **get_me** - Get my user profile + - No parameters required - **get_team_members** - Get team members + - `org`: Organization login (owner) that contains the team. (string, required) - `team_slug`: Team slug (string, required) @@ -489,6 +515,7 @@ The following sets of tools are available (all are on by default): Dependabot - **get_dependabot_alert** - Get dependabot alert + - `alertNumber`: The number of the alert. (number, required) - `owner`: The owner of the repository. (string, required) - `repo`: The name of the repository. (string, required) @@ -506,11 +533,13 @@ The following sets of tools are available (all are on by default): Discussions - **get_discussion** - Get discussion + - `discussionNumber`: Discussion Number (number, required) - `owner`: Repository owner (string, required) - `repo`: Repository name (string, required) - **get_discussion_comments** - Get discussion comments + - `after`: Cursor for pagination. Use the endCursor from the previous page's PageInfo for GraphQL APIs. (string, optional) - `discussionNumber`: Discussion Number (number, required) - `owner`: Repository owner (string, required) @@ -518,6 +547,7 @@ The following sets of tools are available (all are on by default): - `repo`: Repository name (string, required) - **list_discussion_categories** - List discussion categories + - `owner`: Repository owner (string, required) - `repo`: Repository name. If not provided, discussion categories will be queried at the organisation level. (string, optional) @@ -537,12 +567,14 @@ The following sets of tools are available (all are on by default): Gists - **create_gist** - Create Gist + - `content`: Content for simple single-file gist creation (string, required) - `description`: Description of the gist (string, optional) - `filename`: Filename for simple single-file gist creation (string, required) - `public`: Whether the gist is public (boolean, optional) - **list_gists** - List Gists + - `page`: Page number for pagination (min 1) (number, optional) - `perPage`: Results per page for pagination (min 1, max 100) (number, optional) - `since`: Only gists updated after this time (ISO 8601 timestamp) (string, optional) @@ -561,12 +593,14 @@ The following sets of tools are available (all are on by default): Issues - **add_issue_comment** - Add comment to issue + - `body`: Comment content (string, required) - `issue_number`: Issue number to comment on (number, required) - `owner`: Repository owner (string, required) - `repo`: Repository name (string, required) - **add_sub_issue** - Add sub-issue + - `issue_number`: The number of the parent issue (number, required) - `owner`: Repository owner (string, required) - `replace_parent`: When true, replaces the sub-issue's current parent issue (boolean, optional) @@ -574,11 +608,13 @@ The following sets of tools are available (all are on by default): - `sub_issue_id`: The ID of the sub-issue to add. ID is not the same as issue number (number, required) - **assign_copilot_to_issue** - Assign Copilot to issue + - `issueNumber`: Issue number (number, required) - `owner`: Repository owner (string, required) - `repo`: Repository name (string, required) - **create_issue** - Open new issue + - `assignees`: Usernames to assign to this issue (string[], optional) - `body`: Issue body content (string, optional) - `labels`: Labels to apply to this issue (string[], optional) @@ -589,11 +625,13 @@ The following sets of tools are available (all are on by default): - `type`: Type of this issue (string, optional) - **get_issue** - Get issue details + - `issue_number`: The number of the issue (number, required) - `owner`: The owner of the repository (string, required) - `repo`: The name of the repository (string, required) - **get_issue_comments** - Get issue comments + - `issue_number`: Issue number (number, required) - `owner`: Repository owner (string, required) - `page`: Page number for pagination (min 1) (number, optional) @@ -601,14 +639,17 @@ The following sets of tools are available (all are on by default): - `repo`: Repository name (string, required) - **get_label** - Get a specific label from a repository. + - `name`: Label name. (string, required) - `owner`: Repository owner (username or organization name) (string, required) - `repo`: Repository name (string, required) - **list_issue_types** - List available issue types + - `owner`: The organization owner of the repository (string, required) - **list_issues** - List issues + - `after`: Cursor for pagination. Use the endCursor from the previous page's PageInfo for GraphQL APIs. (string, optional) - `direction`: Order direction. If provided, the 'orderBy' also needs to be provided. (string, optional) - `labels`: Filter by labels (string[], optional) @@ -620,11 +661,13 @@ The following sets of tools are available (all are on by default): - `state`: Filter by state, by default both open and closed issues are returned when not provided (string, optional) - **list_label** - List labels from a repository or an issue + - `issue_number`: Issue number - if provided, lists labels on the specific issue (number, optional) - `owner`: Repository owner (username or organization name) - required for all operations (string, required) - `repo`: Repository name - required for all operations (string, required) - **list_sub_issues** - List sub-issues + - `issue_number`: Issue number (number, required) - `owner`: Repository owner (string, required) - `page`: Page number for pagination (default: 1) (number, optional) @@ -632,12 +675,14 @@ The following sets of tools are available (all are on by default): - `repo`: Repository name (string, required) - **remove_sub_issue** - Remove sub-issue + - `issue_number`: The number of the parent issue (number, required) - `owner`: Repository owner (string, required) - `repo`: Repository name (string, required) - `sub_issue_id`: The ID of the sub-issue to remove. ID is not the same as issue number (number, required) - **reprioritize_sub_issue** - Reprioritize sub-issue + - `after_id`: The ID of the sub-issue to be prioritized after (either after_id OR before_id should be specified) (number, optional) - `before_id`: The ID of the sub-issue to be prioritized before (either after_id OR before_id should be specified) (number, optional) - `issue_number`: The number of the parent issue (number, required) @@ -646,6 +691,7 @@ The following sets of tools are available (all are on by default): - `sub_issue_id`: The ID of the sub-issue to reprioritize. ID is not the same as issue number (number, required) - **search_issues** - Search issues + - `order`: Sort order (string, optional) - `owner`: Optional repository owner. If provided with repo, only issues for this repository are listed. (string, optional) - `page`: Page number for pagination (min 1) (number, optional) @@ -655,6 +701,7 @@ The following sets of tools are available (all are on by default): - `sort`: Sort field by number of matches of categories, defaults to best match (string, optional) - **update_issue** - Edit issue + - `assignees`: New assignees (string[], optional) - `body`: New description (string, optional) - `duplicate_of`: Issue number that this issue is a duplicate of. Only used when state_reason is 'duplicate'. (number, optional) @@ -684,11 +731,13 @@ The following sets of tools are available (all are on by default): Labels - **get_label** - Get a specific label from a repository. + - `name`: Label name. (string, required) - `owner`: Repository owner (username or organization name) (string, required) - `repo`: Repository name (string, required) - **list_label** - List labels from a repository or an issue + - `issue_number`: Issue number - if provided, lists labels on the specific issue (number, optional) - `owner`: Repository owner (username or organization name) - required for all operations (string, required) - `repo`: Repository name - required for all operations (string, required) @@ -709,13 +758,16 @@ The following sets of tools are available (all are on by default): Notifications - **dismiss_notification** - Dismiss notification + - `state`: The new state of the notification (read/done) (string, optional) - `threadID`: The ID of the notification thread (string, required) - **get_notification_details** - Get notification details + - `notificationID`: The ID of the notification (string, required) - **list_notifications** - List notifications + - `before`: Only show notifications updated before the given time (ISO 8601 format) (string, optional) - `filter`: Filter notifications to, use default unless specified. Read notifications are ones that have already been acknowledged by the user. Participating notifications are those that the user is directly involved in, such as issues or pull requests they have commented on or created. (string, optional) - `owner`: Optional repository owner. If provided with repo, only notifications for this repository are listed. (string, optional) @@ -725,10 +777,12 @@ The following sets of tools are available (all are on by default): - `since`: Only show notifications updated after the given time (ISO 8601 format) (string, optional) - **manage_notification_subscription** - Manage notification subscription + - `action`: Action to perform: ignore, watch, or delete the notification subscription. (string, required) - `notificationID`: The ID of the notification thread. (string, required) - **manage_repository_notification_subscription** - Manage repository notification subscription + - `action`: Action to perform: ignore, watch, or delete the repository notification subscription. (string, required) - `owner`: The account owner of the repository. (string, required) - `repo`: The name of the repository. (string, required) @@ -758,6 +812,7 @@ The following sets of tools are available (all are on by default): Projects - **add_project_item** - Add project item + - `item_id`: The numeric ID of the issue or pull request to add to the project. (number, required) - `item_type`: The item's type, either issue or pull_request. (string, required) - `owner`: If owner_type == user it is the handle for the GitHub user account. If owner_type == org it is the name of the organization. The name is not case sensitive. (string, required) @@ -765,35 +820,41 @@ The following sets of tools are available (all are on by default): - `project_number`: The project's number. (number, required) - **delete_project_item** - Delete project item + - `item_id`: The internal project item ID to delete from the project (not the issue or pull request ID). (number, required) - `owner`: If owner_type == user it is the handle for the GitHub user account. If owner_type == org it is the name of the organization. The name is not case sensitive. (string, required) - `owner_type`: Owner type (string, required) - `project_number`: The project's number. (number, required) - **get_project** - Get project + - `owner`: If owner_type == user it is the handle for the GitHub user account. If owner_type == org it is the name of the organization. The name is not case sensitive. (string, required) - `owner_type`: Owner type (string, required) - `project_number`: The project's number (number, required) - **get_project_field** - Get project field + - `field_id`: The field's id. (number, required) - `owner`: If owner_type == user it is the handle for the GitHub user account. If owner_type == org it is the name of the organization. The name is not case sensitive. (string, required) - `owner_type`: Owner type (string, required) - `project_number`: The project's number. (number, required) - **get_project_item** - Get project item + - `item_id`: The item's ID. (number, required) - `owner`: If owner_type == user it is the handle for the GitHub user account. If owner_type == org it is the name of the organization. The name is not case sensitive. (string, required) - `owner_type`: Owner type (string, required) - `project_number`: The project's number. (number, required) - **list_project_fields** - List project fields + - `owner`: If owner_type == user it is the handle for the GitHub user account. If owner_type == org it is the name of the organization. The name is not case sensitive. (string, required) - `owner_type`: Owner type (string, required) - `per_page`: Number of results per page (max 100, default: 30) (number, optional) - `project_number`: The project's number. (number, required) - **list_project_items** - List project items + - `owner`: If owner_type == user it is the handle for the GitHub user account. If owner_type == org it is the name of the organization. The name is not case sensitive. (string, required) - `owner_type`: Owner type (string, required) - `per_page`: Number of results per page (max 100, default: 30) (number, optional) @@ -813,6 +874,7 @@ The following sets of tools are available (all are on by default): Pull Requests - **add_comment_to_pending_review** - Add review comment to the requester's latest pending pull request review + - `body`: The text of the review comment (string, required) - `line`: The line of the blob in the pull request diff that the comment applies to. For multi-line comments, the last line of the range (number, optional) - `owner`: Repository owner (string, required) @@ -825,6 +887,7 @@ The following sets of tools are available (all are on by default): - `subjectType`: The level at which the comment is targeted (string, required) - **create_and_submit_pull_request_review** - Create and submit a pull request review without comments + - `body`: Review comment text (string, required) - `commitID`: SHA of commit to review (string, optional) - `event`: Review action to perform (string, required) @@ -833,12 +896,14 @@ The following sets of tools are available (all are on by default): - `repo`: Repository name (string, required) - **create_pending_pull_request_review** - Create pending pull request review + - `commitID`: SHA of commit to review (string, optional) - `owner`: Repository owner (string, required) - `pullNumber`: Pull request number (number, required) - `repo`: Repository name (string, required) - **create_pull_request** - Open new pull request + - `base`: Branch to merge into (string, required) - `body`: PR description (string, optional) - `draft`: Create as draft PR (boolean, optional) @@ -849,11 +914,13 @@ The following sets of tools are available (all are on by default): - `title`: PR title (string, required) - **delete_pending_pull_request_review** - Delete the requester's latest pending pull request review + - `owner`: Repository owner (string, required) - `pullNumber`: Pull request number (number, required) - `repo`: Repository name (string, required) - **list_pull_requests** - List pull requests + - `base`: Filter by base branch (string, optional) - `direction`: Sort direction (string, optional) - `head`: Filter by head user/org and branch (string, optional) @@ -865,6 +932,7 @@ The following sets of tools are available (all are on by default): - `state`: Filter by state (string, optional) - **merge_pull_request** - Merge pull request + - `commit_message`: Extra detail for merge commit (string, optional) - `commit_title`: Title for merge commit (string, optional) - `merge_method`: Merge method (string, optional) @@ -873,27 +941,31 @@ The following sets of tools are available (all are on by default): - `repo`: Repository name (string, required) - **pull_request_read** - Get details for a single pull request - - `method`: Action to specify what pull request data needs to be retrieved from GitHub. -Possible options: - 1. get - Get details of a specific pull request. - 2. get_diff - Get the diff of a pull request. - 3. get_status - Get status of a head commit in a pull request. This reflects status of builds and checks. - 4. get_files - Get the list of files changed in a pull request. Use with pagination parameters to control the number of results returned. - 5. get_review_comments - Get the review comments on a pull request. Use with pagination parameters to control the number of results returned. - 6. get_reviews - Get the reviews on a pull request. When asked for review comments, use get_review_comments method. - (string, required) - - `owner`: Repository owner (string, required) - - `page`: Page number for pagination (min 1) (number, optional) - - `perPage`: Results per page for pagination (min 1, max 100) (number, optional) - - `pullNumber`: Pull request number (number, required) - - `repo`: Repository name (string, required) + - `method`: Action to specify what pull request data needs to be retrieved from GitHub. + Possible options: + +1. get - Get details of a specific pull request. +2. get_diff - Get the diff of a pull request. +3. get_status - Get status of a head commit in a pull request. This reflects status of builds and checks. +4. get_files - Get the list of files changed in a pull request. Use with pagination parameters to control the number of results returned. +5. get_review_comments - Get the review comments on a pull request. Use with pagination parameters to control the number of results returned. +6. get_reviews - Get the reviews on a pull request. When asked for review comments, use get_review_comments method. + (string, required) + +- `owner`: Repository owner (string, required) +- `page`: Page number for pagination (min 1) (number, optional) +- `perPage`: Results per page for pagination (min 1, max 100) (number, optional) +- `pullNumber`: Pull request number (number, required) +- `repo`: Repository name (string, required) - **request_copilot_review** - Request Copilot review + - `owner`: Repository owner (string, required) - `pullNumber`: Pull request number (number, required) - `repo`: Repository name (string, required) - **search_pull_requests** - Search pull requests + - `order`: Sort order (string, optional) - `owner`: Optional repository owner. If provided with repo, only pull requests for this repository are listed. (string, optional) - `page`: Page number for pagination (min 1) (number, optional) @@ -903,6 +975,7 @@ Possible options: - `sort`: Sort field by number of matches of categories, defaults to best match (string, optional) - **submit_pending_pull_request_review** - Submit the requester's latest pending pull request review + - `body`: The text of the review comment (string, optional) - `event`: The event to perform (string, required) - `owner`: Repository owner (string, required) @@ -910,6 +983,7 @@ Possible options: - `repo`: Repository name (string, required) - **update_pull_request** - Edit pull request + - `base`: New base branch name (string, optional) - `body`: New description (string, optional) - `draft`: Mark pull request as draft (true) or ready for review (false) (boolean, optional) @@ -934,12 +1008,14 @@ Possible options: Repositories - **create_branch** - Create branch + - `branch`: Name for new branch (string, required) - `from_branch`: Source branch (defaults to repo default) (string, optional) - `owner`: Repository owner (string, required) - `repo`: Repository name (string, required) - **create_or_update_file** - Create or update file + - `branch`: Branch to create/update the file in (string, required) - `content`: Content of the file (string, required) - `message`: Commit message (string, required) @@ -949,6 +1025,7 @@ Possible options: - `sha`: Required if updating an existing file. The blob SHA of the file being replaced. (string, optional) - **create_repository** - Create repository + - `autoInit`: Initialize with README (boolean, optional) - `description`: Repository description (string, optional) - `name`: Repository name (string, required) @@ -956,6 +1033,7 @@ Possible options: - `private`: Whether repo should be private (boolean, optional) - **delete_file** - Delete file + - `branch`: Branch to delete the file from (string, required) - `message`: Commit message (string, required) - `owner`: Repository owner (username or organization) (string, required) @@ -963,11 +1041,13 @@ Possible options: - `repo`: Repository name (string, required) - **fork_repository** - Fork repository + - `organization`: Organization to fork to (string, optional) - `owner`: Repository owner (string, required) - `repo`: Repository name (string, required) - **get_commit** - Get commit details + - `include_diff`: Whether to include file diffs and stats in the response. Default is true. (boolean, optional) - `owner`: Repository owner (string, required) - `page`: Page number for pagination (min 1) (number, optional) @@ -976,6 +1056,7 @@ Possible options: - `sha`: Commit SHA, branch name, or tag name (string, required) - **get_file_contents** - Get file or directory contents + - `owner`: Repository owner (username or organization) (string, required) - `path`: Path to file/directory (directories must end with a slash '/') (string, optional) - `ref`: Accepts optional git refs such as `refs/tags/{tag}`, `refs/heads/{branch}` or `refs/pull/{pr_number}/head` (string, optional) @@ -983,26 +1064,31 @@ Possible options: - `sha`: Accepts optional commit SHA. If specified, it will be used instead of ref (string, optional) - **get_latest_release** - Get latest release + - `owner`: Repository owner (string, required) - `repo`: Repository name (string, required) - **get_release_by_tag** - Get a release by tag name + - `owner`: Repository owner (string, required) - `repo`: Repository name (string, required) - `tag`: Tag name (e.g., 'v1.0.0') (string, required) - **get_tag** - Get tag details + - `owner`: Repository owner (string, required) - `repo`: Repository name (string, required) - `tag`: Tag name (string, required) - **list_branches** - List branches + - `owner`: Repository owner (string, required) - `page`: Page number for pagination (min 1) (number, optional) - `perPage`: Results per page for pagination (min 1, max 100) (number, optional) - `repo`: Repository name (string, required) - **list_commits** - List commits + - `author`: Author username or email address to filter commits by (string, optional) - `owner`: Repository owner (string, required) - `page`: Page number for pagination (min 1) (number, optional) @@ -1011,18 +1097,21 @@ Possible options: - `sha`: Commit SHA, branch or tag name to list commits of. If not provided, uses the default branch of the repository. If a commit SHA is provided, will list commits up to that SHA. (string, optional) - **list_releases** - List releases + - `owner`: Repository owner (string, required) - `page`: Page number for pagination (min 1) (number, optional) - `perPage`: Results per page for pagination (min 1, max 100) (number, optional) - `repo`: Repository name (string, required) - **list_tags** - List tags + - `owner`: Repository owner (string, required) - `page`: Page number for pagination (min 1) (number, optional) - `perPage`: Results per page for pagination (min 1, max 100) (number, optional) - `repo`: Repository name (string, required) - **push_files** - Push files to repository + - `branch`: Branch to push to (string, required) - `files`: Array of file objects to push, each object with path (string) and content (string) (object[], required) - `message`: Commit message (string, required) @@ -1030,6 +1119,7 @@ Possible options: - `repo`: Repository name (string, required) - **search_code** - Search code + - `order`: Sort order for results (string, optional) - `page`: Page number for pagination (min 1) (number, optional) - `perPage`: Results per page for pagination (min 1, max 100) (number, optional) @@ -1051,6 +1141,7 @@ Possible options: Secret Protection - **get_secret_scanning_alert** - Get secret scanning alert + - `alertNumber`: The number of the alert. (number, required) - `owner`: The owner of the repository. (string, required) - `repo`: The name of the repository. (string, required) @@ -1069,9 +1160,11 @@ Possible options: Security Advisories - **get_global_security_advisory** - Get a global security advisory + - `ghsaId`: GitHub Security Advisory ID (format: GHSA-xxxx-xxxx-xxxx). (string, required) - **list_global_security_advisories** - List global security advisories + - `affects`: Filter advisories by affected package or version (e.g. "package1,package2@1.0.0"). (string, optional) - `cveId`: Filter by CVE ID. (string, optional) - `cwes`: Filter by Common Weakness Enumeration IDs (e.g. ["79", "284", "22"]). (string[], optional) @@ -1085,6 +1178,7 @@ Possible options: - `updated`: Filter by update date or date range (ISO 8601 date or range). (string, optional) - **list_org_repository_security_advisories** - List org repository security advisories + - `direction`: Sort direction. (string, optional) - `org`: The organization login. (string, required) - `sort`: Sort field. (string, optional) @@ -1104,6 +1198,7 @@ Possible options: Stargazers - **list_starred_repositories** - List starred repositories + - `direction`: The direction to sort the results by. (string, optional) - `page`: Page number for pagination (min 1) (number, optional) - `perPage`: Results per page for pagination (min 1, max 100) (number, optional) @@ -1111,6 +1206,7 @@ Possible options: - `username`: Username to list starred repositories for. Defaults to the authenticated user. (string, optional) - **star_repository** - Star repository + - `owner`: Repository owner (string, required) - `repo`: Repository name (string, required) @@ -1140,12 +1236,12 @@ Possible options: Copilot coding agent -- **create_pull_request_with_copilot** - Perform task with GitHub Copilot coding agent - - `owner`: Repository owner. You can guess the owner, but confirm it with the user before proceeding. (string, required) - - `repo`: Repository name. You can guess the repository name, but confirm it with the user before proceeding. (string, required) - - `problem_statement`: Detailed description of the task to be performed (e.g., 'Implement a feature that does X', 'Fix bug Y', etc.) (string, required) - - `title`: Title for the pull request that will be created (string, required) - - `base_ref`: Git reference (e.g., branch) that the agent will start its work from. If not specified, defaults to the repository's default branch (string, optional) +- **create_pull_request_with_copilot** - Perform task with GitHub Copilot coding agent + - `owner`: Repository owner. You can guess the owner, but confirm it with the user before proceeding. (string, required) + - `repo`: Repository name. You can guess the repository name, but confirm it with the user before proceeding. (string, required) + - `problem_statement`: Detailed description of the task to be performed (e.g., 'Implement a feature that does X', 'Fix bug Y', etc.) (string, required) + - `title`: Title for the pull request that will be created (string, required) + - `base_ref`: Git reference (e.g., branch) that the agent will start its work from. If not specified, defaults to the repository's default branch (string, optional)
@@ -1153,18 +1249,18 @@ Possible options: Copilot Spaces -- **get_copilot_space** - Get Copilot Space - - `owner`: The owner of the space. (string, required) - - `name`: The name of the space. (string, required) +- **get_copilot_space** - Get Copilot Space -- **list_copilot_spaces** - List Copilot Spaces + - `owner`: The owner of the space. (string, required) + - `name`: The name of the space. (string, required) + +- **list_copilot_spaces** - List Copilot Spaces
-Web Search +Web Search (note: only available for users on a paid Copilot subscription, and with Web search enabled) -- **web_search** - Web Search - - `query`: A natural language query representing what to search for on the web. (string, required) +- **web_search** - Web Search - `query`: A natural language query representing what to search for on the web. (string, required)
## Dynamic Tool Discovery @@ -1214,7 +1310,8 @@ the hostname for GitHub Enterprise Server or GitHub Enterprise Cloud with data r - For GitHub Enterprise Server, prefix the hostname with the `https://` URI scheme, as it otherwise defaults to `http://`, which GitHub Enterprise Server does not support. - For GitHub Enterprise Cloud with data residency, use `https://YOURSUBDOMAIN.ghe.com` as the hostname. -``` json + +```json "github": { "command": "docker", "args": [ From a7a8cfa9d0b6c4052a767965227bc25e9224b7fa Mon Sep 17 00:00:00 2001 From: tommaso-moro Date: Thu, 9 Oct 2025 19:01:30 +0100 Subject: [PATCH 3/8] update --- README.md | 197 ++++++++++++++---------------------------------------- 1 file changed, 50 insertions(+), 147 deletions(-) diff --git a/README.md b/README.md index 6cc032de6..da63108bb 100644 --- a/README.md +++ b/README.md @@ -78,7 +78,6 @@ Alternatively, to manually configure VS Code, choose the appropriate JSON block ### Install in other MCP hosts - - **[GitHub Copilot in other IDEs](/docs/installation-guides/install-other-copilot-ides.md)** - Installation for JetBrains, Visual Studio, Eclipse, and Xcode with GitHub Copilot - **[Claude Applications](/docs/installation-guides/install-claude.md)** - Installation guide for Claude Web, Claude Desktop and Claude Code CLI - **[Cursor](/docs/installation-guides/install-cursor.md)** - Installation guide for Cursor IDE @@ -91,7 +90,6 @@ Alternatively, to manually configure VS Code, choose the appropriate JSON block #### Default toolset configuration The default configuration is: - - context - repos - issues @@ -111,35 +109,29 @@ See [Remote Server Documentation](docs/remote-server.md) for full details on rem 1. To run the server in a container, you will need to have [Docker](https://www.docker.com/) installed. 2. Once Docker is installed, you will also need to ensure Docker is running. The image is public; if you get errors on pull, you may have an expired token and need to `docker logout ghcr.io`. 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)). +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)).
Handling PATs Securely ### Environment Variables (Recommended) - To keep your GitHub PAT secure and reusable across different MCP hosts: 1. **Store your PAT in environment variables** - ```bash export GITHUB_PAT=your_token_here ``` - Or create a `.env` file: - ```env GITHUB_PAT=your_token_here ``` 2. **Protect your `.env` file** - ```bash # Add to .gitignore to prevent accidental commits echo ".env" >> .gitignore ``` 3. **Reference the token in configurations** - ```bash # CLI usage claude mcp update github -e GITHUB_PERSONAL_ACCESS_TOKEN=$GITHUB_PAT @@ -338,28 +330,26 @@ GITHUB_TOOLSETS="all" ./github-mcp-server The following sets of tools are available (all are on by default): - -| Toolset | Description | -| --------------------- | ------------------------------------------------------------------------------------------------------------------- | -| `context` | **Strongly recommended**: Tools that provide context about the current user and GitHub context you are operating in | -| `actions` | GitHub Actions workflows and CI/CD operations | -| `code_security` | Code security related tools, such as GitHub Code Scanning | -| `dependabot` | Dependabot tools | -| `discussions` | GitHub Discussions related tools | -| `experiments` | Experimental features that are not considered stable yet | -| `gists` | GitHub Gist related tools | -| `issues` | GitHub Issues related tools | -| `labels` | GitHub Labels related tools | -| `notifications` | GitHub Notifications related tools | -| `orgs` | GitHub Organization related tools | -| `projects` | GitHub Projects related tools | -| `pull_requests` | GitHub Pull Request related tools | -| `repos` | GitHub Repository related tools | -| `secret_protection` | Secret protection related tools, such as GitHub Secret Scanning | -| `security_advisories` | Security advisories related tools | -| `stargazers` | GitHub Stargazers related tools | -| `users` | GitHub User related tools | - +| Toolset | Description | +| ----------------------- | ------------------------------------------------------------- | +| `context` | **Strongly recommended**: Tools that provide context about the current user and GitHub context you are operating in | +| `actions` | GitHub Actions workflows and CI/CD operations | +| `code_security` | Code security related tools, such as GitHub Code Scanning | +| `dependabot` | Dependabot tools | +| `discussions` | GitHub Discussions related tools | +| `experiments` | Experimental features that are not considered stable yet | +| `gists` | GitHub Gist related tools | +| `issues` | GitHub Issues related tools | +| `labels` | GitHub Labels related tools | +| `notifications` | GitHub Notifications related tools | +| `orgs` | GitHub Organization related tools | +| `projects` | GitHub Projects related tools | +| `pull_requests` | GitHub Pull Request related tools | +| `repos` | GitHub Repository related tools | +| `secret_protection` | Secret protection related tools, such as GitHub Secret Scanning | +| `security_advisories` | Security advisories related tools | +| `stargazers` | GitHub Stargazers related tools | +| `users` | GitHub User related tools | ## Tools @@ -370,25 +360,21 @@ The following sets of tools are available (all are on by default): Actions - **cancel_workflow_run** - Cancel workflow run - - `owner`: Repository owner (string, required) - `repo`: Repository name (string, required) - `run_id`: The unique identifier of the workflow run (number, required) - **delete_workflow_run_logs** - Delete workflow logs - - `owner`: Repository owner (string, required) - `repo`: Repository name (string, required) - `run_id`: The unique identifier of the workflow run (number, required) - **download_workflow_run_artifact** - Download workflow artifact - - `artifact_id`: The unique identifier of the artifact (number, required) - `owner`: Repository owner (string, required) - `repo`: Repository name (string, required) - **get_job_logs** - Get job logs - - `failed_only`: When true, gets logs for all failed jobs in run_id (boolean, optional) - `job_id`: The unique identifier of the workflow job (required for single job logs) (number, optional) - `owner`: Repository owner (string, required) @@ -398,25 +384,21 @@ The following sets of tools are available (all are on by default): - `tail_lines`: Number of lines to return from the end of the log (number, optional) - **get_workflow_run** - Get workflow run - - `owner`: Repository owner (string, required) - `repo`: Repository name (string, required) - `run_id`: The unique identifier of the workflow run (number, required) - **get_workflow_run_logs** - Get workflow run logs - - `owner`: Repository owner (string, required) - `repo`: Repository name (string, required) - `run_id`: The unique identifier of the workflow run (number, required) - **get_workflow_run_usage** - Get workflow usage - - `owner`: Repository owner (string, required) - `repo`: Repository name (string, required) - `run_id`: The unique identifier of the workflow run (number, required) - **list_workflow_jobs** - List workflow jobs - - `filter`: Filters jobs by their completed_at timestamp (string, optional) - `owner`: Repository owner (string, required) - `page`: Page number for pagination (min 1) (number, optional) @@ -425,7 +407,6 @@ The following sets of tools are available (all are on by default): - `run_id`: The unique identifier of the workflow run (number, required) - **list_workflow_run_artifacts** - List workflow artifacts - - `owner`: Repository owner (string, required) - `page`: Page number for pagination (min 1) (number, optional) - `perPage`: Results per page for pagination (min 1, max 100) (number, optional) @@ -433,7 +414,6 @@ The following sets of tools are available (all are on by default): - `run_id`: The unique identifier of the workflow run (number, required) - **list_workflow_runs** - List workflow runs - - `actor`: Returns someone's workflow runs. Use the login for the user who created the workflow run. (string, optional) - `branch`: Returns workflow runs associated with a branch. Use the name of the branch. (string, optional) - `event`: Returns workflow runs for a specific event type (string, optional) @@ -445,20 +425,17 @@ The following sets of tools are available (all are on by default): - `workflow_id`: The workflow ID or workflow file name (string, required) - **list_workflows** - List workflows - - `owner`: Repository owner (string, required) - `page`: Page number for pagination (min 1) (number, optional) - `perPage`: Results per page for pagination (min 1, max 100) (number, optional) - `repo`: Repository name (string, required) - **rerun_failed_jobs** - Rerun failed jobs - - `owner`: Repository owner (string, required) - `repo`: Repository name (string, required) - `run_id`: The unique identifier of the workflow run (number, required) - **rerun_workflow_run** - Rerun workflow run - - `owner`: Repository owner (string, required) - `repo`: Repository name (string, required) - `run_id`: The unique identifier of the workflow run (number, required) @@ -477,7 +454,6 @@ The following sets of tools are available (all are on by default): Code Security - **get_code_scanning_alert** - Get code scanning alert - - `alertNumber`: The number of the alert. (number, required) - `owner`: The owner of the repository. (string, required) - `repo`: The name of the repository. (string, required) @@ -497,11 +473,9 @@ The following sets of tools are available (all are on by default): Context - **get_me** - Get my user profile - - No parameters required - **get_team_members** - Get team members - - `org`: Organization login (owner) that contains the team. (string, required) - `team_slug`: Team slug (string, required) @@ -515,7 +489,6 @@ The following sets of tools are available (all are on by default): Dependabot - **get_dependabot_alert** - Get dependabot alert - - `alertNumber`: The number of the alert. (number, required) - `owner`: The owner of the repository. (string, required) - `repo`: The name of the repository. (string, required) @@ -533,13 +506,11 @@ The following sets of tools are available (all are on by default): Discussions - **get_discussion** - Get discussion - - `discussionNumber`: Discussion Number (number, required) - `owner`: Repository owner (string, required) - `repo`: Repository name (string, required) - **get_discussion_comments** - Get discussion comments - - `after`: Cursor for pagination. Use the endCursor from the previous page's PageInfo for GraphQL APIs. (string, optional) - `discussionNumber`: Discussion Number (number, required) - `owner`: Repository owner (string, required) @@ -547,7 +518,6 @@ The following sets of tools are available (all are on by default): - `repo`: Repository name (string, required) - **list_discussion_categories** - List discussion categories - - `owner`: Repository owner (string, required) - `repo`: Repository name. If not provided, discussion categories will be queried at the organisation level. (string, optional) @@ -567,14 +537,12 @@ The following sets of tools are available (all are on by default): Gists - **create_gist** - Create Gist - - `content`: Content for simple single-file gist creation (string, required) - `description`: Description of the gist (string, optional) - `filename`: Filename for simple single-file gist creation (string, required) - `public`: Whether the gist is public (boolean, optional) - **list_gists** - List Gists - - `page`: Page number for pagination (min 1) (number, optional) - `perPage`: Results per page for pagination (min 1, max 100) (number, optional) - `since`: Only gists updated after this time (ISO 8601 timestamp) (string, optional) @@ -593,14 +561,12 @@ The following sets of tools are available (all are on by default): Issues - **add_issue_comment** - Add comment to issue - - `body`: Comment content (string, required) - `issue_number`: Issue number to comment on (number, required) - `owner`: Repository owner (string, required) - `repo`: Repository name (string, required) - **add_sub_issue** - Add sub-issue - - `issue_number`: The number of the parent issue (number, required) - `owner`: Repository owner (string, required) - `replace_parent`: When true, replaces the sub-issue's current parent issue (boolean, optional) @@ -608,13 +574,11 @@ The following sets of tools are available (all are on by default): - `sub_issue_id`: The ID of the sub-issue to add. ID is not the same as issue number (number, required) - **assign_copilot_to_issue** - Assign Copilot to issue - - `issueNumber`: Issue number (number, required) - `owner`: Repository owner (string, required) - `repo`: Repository name (string, required) - **create_issue** - Open new issue - - `assignees`: Usernames to assign to this issue (string[], optional) - `body`: Issue body content (string, optional) - `labels`: Labels to apply to this issue (string[], optional) @@ -625,13 +589,11 @@ The following sets of tools are available (all are on by default): - `type`: Type of this issue (string, optional) - **get_issue** - Get issue details - - `issue_number`: The number of the issue (number, required) - `owner`: The owner of the repository (string, required) - `repo`: The name of the repository (string, required) - **get_issue_comments** - Get issue comments - - `issue_number`: Issue number (number, required) - `owner`: Repository owner (string, required) - `page`: Page number for pagination (min 1) (number, optional) @@ -639,17 +601,14 @@ The following sets of tools are available (all are on by default): - `repo`: Repository name (string, required) - **get_label** - Get a specific label from a repository. - - `name`: Label name. (string, required) - `owner`: Repository owner (username or organization name) (string, required) - `repo`: Repository name (string, required) - **list_issue_types** - List available issue types - - `owner`: The organization owner of the repository (string, required) - **list_issues** - List issues - - `after`: Cursor for pagination. Use the endCursor from the previous page's PageInfo for GraphQL APIs. (string, optional) - `direction`: Order direction. If provided, the 'orderBy' also needs to be provided. (string, optional) - `labels`: Filter by labels (string[], optional) @@ -661,13 +620,11 @@ The following sets of tools are available (all are on by default): - `state`: Filter by state, by default both open and closed issues are returned when not provided (string, optional) - **list_label** - List labels from a repository or an issue - - `issue_number`: Issue number - if provided, lists labels on the specific issue (number, optional) - `owner`: Repository owner (username or organization name) - required for all operations (string, required) - `repo`: Repository name - required for all operations (string, required) - **list_sub_issues** - List sub-issues - - `issue_number`: Issue number (number, required) - `owner`: Repository owner (string, required) - `page`: Page number for pagination (default: 1) (number, optional) @@ -675,14 +632,12 @@ The following sets of tools are available (all are on by default): - `repo`: Repository name (string, required) - **remove_sub_issue** - Remove sub-issue - - `issue_number`: The number of the parent issue (number, required) - `owner`: Repository owner (string, required) - `repo`: Repository name (string, required) - `sub_issue_id`: The ID of the sub-issue to remove. ID is not the same as issue number (number, required) - **reprioritize_sub_issue** - Reprioritize sub-issue - - `after_id`: The ID of the sub-issue to be prioritized after (either after_id OR before_id should be specified) (number, optional) - `before_id`: The ID of the sub-issue to be prioritized before (either after_id OR before_id should be specified) (number, optional) - `issue_number`: The number of the parent issue (number, required) @@ -691,7 +646,6 @@ The following sets of tools are available (all are on by default): - `sub_issue_id`: The ID of the sub-issue to reprioritize. ID is not the same as issue number (number, required) - **search_issues** - Search issues - - `order`: Sort order (string, optional) - `owner`: Optional repository owner. If provided with repo, only issues for this repository are listed. (string, optional) - `page`: Page number for pagination (min 1) (number, optional) @@ -701,7 +655,6 @@ The following sets of tools are available (all are on by default): - `sort`: Sort field by number of matches of categories, defaults to best match (string, optional) - **update_issue** - Edit issue - - `assignees`: New assignees (string[], optional) - `body`: New description (string, optional) - `duplicate_of`: Issue number that this issue is a duplicate of. Only used when state_reason is 'duplicate'. (number, optional) @@ -731,13 +684,11 @@ The following sets of tools are available (all are on by default): Labels - **get_label** - Get a specific label from a repository. - - `name`: Label name. (string, required) - `owner`: Repository owner (username or organization name) (string, required) - `repo`: Repository name (string, required) - **list_label** - List labels from a repository or an issue - - `issue_number`: Issue number - if provided, lists labels on the specific issue (number, optional) - `owner`: Repository owner (username or organization name) - required for all operations (string, required) - `repo`: Repository name - required for all operations (string, required) @@ -758,16 +709,13 @@ The following sets of tools are available (all are on by default): Notifications - **dismiss_notification** - Dismiss notification - - `state`: The new state of the notification (read/done) (string, optional) - `threadID`: The ID of the notification thread (string, required) - **get_notification_details** - Get notification details - - `notificationID`: The ID of the notification (string, required) - **list_notifications** - List notifications - - `before`: Only show notifications updated before the given time (ISO 8601 format) (string, optional) - `filter`: Filter notifications to, use default unless specified. Read notifications are ones that have already been acknowledged by the user. Participating notifications are those that the user is directly involved in, such as issues or pull requests they have commented on or created. (string, optional) - `owner`: Optional repository owner. If provided with repo, only notifications for this repository are listed. (string, optional) @@ -777,12 +725,10 @@ The following sets of tools are available (all are on by default): - `since`: Only show notifications updated after the given time (ISO 8601 format) (string, optional) - **manage_notification_subscription** - Manage notification subscription - - `action`: Action to perform: ignore, watch, or delete the notification subscription. (string, required) - `notificationID`: The ID of the notification thread. (string, required) - **manage_repository_notification_subscription** - Manage repository notification subscription - - `action`: Action to perform: ignore, watch, or delete the repository notification subscription. (string, required) - `owner`: The account owner of the repository. (string, required) - `repo`: The name of the repository. (string, required) @@ -812,7 +758,6 @@ The following sets of tools are available (all are on by default): Projects - **add_project_item** - Add project item - - `item_id`: The numeric ID of the issue or pull request to add to the project. (number, required) - `item_type`: The item's type, either issue or pull_request. (string, required) - `owner`: If owner_type == user it is the handle for the GitHub user account. If owner_type == org it is the name of the organization. The name is not case sensitive. (string, required) @@ -820,41 +765,35 @@ The following sets of tools are available (all are on by default): - `project_number`: The project's number. (number, required) - **delete_project_item** - Delete project item - - `item_id`: The internal project item ID to delete from the project (not the issue or pull request ID). (number, required) - `owner`: If owner_type == user it is the handle for the GitHub user account. If owner_type == org it is the name of the organization. The name is not case sensitive. (string, required) - `owner_type`: Owner type (string, required) - `project_number`: The project's number. (number, required) - **get_project** - Get project - - `owner`: If owner_type == user it is the handle for the GitHub user account. If owner_type == org it is the name of the organization. The name is not case sensitive. (string, required) - `owner_type`: Owner type (string, required) - `project_number`: The project's number (number, required) - **get_project_field** - Get project field - - `field_id`: The field's id. (number, required) - `owner`: If owner_type == user it is the handle for the GitHub user account. If owner_type == org it is the name of the organization. The name is not case sensitive. (string, required) - `owner_type`: Owner type (string, required) - `project_number`: The project's number. (number, required) - **get_project_item** - Get project item - - `item_id`: The item's ID. (number, required) - `owner`: If owner_type == user it is the handle for the GitHub user account. If owner_type == org it is the name of the organization. The name is not case sensitive. (string, required) - `owner_type`: Owner type (string, required) - `project_number`: The project's number. (number, required) - **list_project_fields** - List project fields - - `owner`: If owner_type == user it is the handle for the GitHub user account. If owner_type == org it is the name of the organization. The name is not case sensitive. (string, required) - `owner_type`: Owner type (string, required) - `per_page`: Number of results per page (max 100, default: 30) (number, optional) - `project_number`: The project's number. (number, required) - **list_project_items** - List project items - - `owner`: If owner_type == user it is the handle for the GitHub user account. If owner_type == org it is the name of the organization. The name is not case sensitive. (string, required) - `owner_type`: Owner type (string, required) - `per_page`: Number of results per page (max 100, default: 30) (number, optional) @@ -874,7 +813,6 @@ The following sets of tools are available (all are on by default): Pull Requests - **add_comment_to_pending_review** - Add review comment to the requester's latest pending pull request review - - `body`: The text of the review comment (string, required) - `line`: The line of the blob in the pull request diff that the comment applies to. For multi-line comments, the last line of the range (number, optional) - `owner`: Repository owner (string, required) @@ -887,7 +825,6 @@ The following sets of tools are available (all are on by default): - `subjectType`: The level at which the comment is targeted (string, required) - **create_and_submit_pull_request_review** - Create and submit a pull request review without comments - - `body`: Review comment text (string, required) - `commitID`: SHA of commit to review (string, optional) - `event`: Review action to perform (string, required) @@ -896,14 +833,12 @@ The following sets of tools are available (all are on by default): - `repo`: Repository name (string, required) - **create_pending_pull_request_review** - Create pending pull request review - - `commitID`: SHA of commit to review (string, optional) - `owner`: Repository owner (string, required) - `pullNumber`: Pull request number (number, required) - `repo`: Repository name (string, required) - **create_pull_request** - Open new pull request - - `base`: Branch to merge into (string, required) - `body`: PR description (string, optional) - `draft`: Create as draft PR (boolean, optional) @@ -914,13 +849,11 @@ The following sets of tools are available (all are on by default): - `title`: PR title (string, required) - **delete_pending_pull_request_review** - Delete the requester's latest pending pull request review - - `owner`: Repository owner (string, required) - `pullNumber`: Pull request number (number, required) - `repo`: Repository name (string, required) - **list_pull_requests** - List pull requests - - `base`: Filter by base branch (string, optional) - `direction`: Sort direction (string, optional) - `head`: Filter by head user/org and branch (string, optional) @@ -932,7 +865,6 @@ The following sets of tools are available (all are on by default): - `state`: Filter by state (string, optional) - **merge_pull_request** - Merge pull request - - `commit_message`: Extra detail for merge commit (string, optional) - `commit_title`: Title for merge commit (string, optional) - `merge_method`: Merge method (string, optional) @@ -941,31 +873,27 @@ The following sets of tools are available (all are on by default): - `repo`: Repository name (string, required) - **pull_request_read** - Get details for a single pull request - - `method`: Action to specify what pull request data needs to be retrieved from GitHub. - Possible options: - -1. get - Get details of a specific pull request. -2. get_diff - Get the diff of a pull request. -3. get_status - Get status of a head commit in a pull request. This reflects status of builds and checks. -4. get_files - Get the list of files changed in a pull request. Use with pagination parameters to control the number of results returned. -5. get_review_comments - Get the review comments on a pull request. Use with pagination parameters to control the number of results returned. -6. get_reviews - Get the reviews on a pull request. When asked for review comments, use get_review_comments method. - (string, required) - -- `owner`: Repository owner (string, required) -- `page`: Page number for pagination (min 1) (number, optional) -- `perPage`: Results per page for pagination (min 1, max 100) (number, optional) -- `pullNumber`: Pull request number (number, required) -- `repo`: Repository name (string, required) + - `method`: Action to specify what pull request data needs to be retrieved from GitHub. +Possible options: + 1. get - Get details of a specific pull request. + 2. get_diff - Get the diff of a pull request. + 3. get_status - Get status of a head commit in a pull request. This reflects status of builds and checks. + 4. get_files - Get the list of files changed in a pull request. Use with pagination parameters to control the number of results returned. + 5. get_review_comments - Get the review comments on a pull request. Use with pagination parameters to control the number of results returned. + 6. get_reviews - Get the reviews on a pull request. When asked for review comments, use get_review_comments method. + (string, required) + - `owner`: Repository owner (string, required) + - `page`: Page number for pagination (min 1) (number, optional) + - `perPage`: Results per page for pagination (min 1, max 100) (number, optional) + - `pullNumber`: Pull request number (number, required) + - `repo`: Repository name (string, required) - **request_copilot_review** - Request Copilot review - - `owner`: Repository owner (string, required) - `pullNumber`: Pull request number (number, required) - `repo`: Repository name (string, required) - **search_pull_requests** - Search pull requests - - `order`: Sort order (string, optional) - `owner`: Optional repository owner. If provided with repo, only pull requests for this repository are listed. (string, optional) - `page`: Page number for pagination (min 1) (number, optional) @@ -975,7 +903,6 @@ The following sets of tools are available (all are on by default): - `sort`: Sort field by number of matches of categories, defaults to best match (string, optional) - **submit_pending_pull_request_review** - Submit the requester's latest pending pull request review - - `body`: The text of the review comment (string, optional) - `event`: The event to perform (string, required) - `owner`: Repository owner (string, required) @@ -983,7 +910,6 @@ The following sets of tools are available (all are on by default): - `repo`: Repository name (string, required) - **update_pull_request** - Edit pull request - - `base`: New base branch name (string, optional) - `body`: New description (string, optional) - `draft`: Mark pull request as draft (true) or ready for review (false) (boolean, optional) @@ -1008,14 +934,12 @@ The following sets of tools are available (all are on by default): Repositories - **create_branch** - Create branch - - `branch`: Name for new branch (string, required) - `from_branch`: Source branch (defaults to repo default) (string, optional) - `owner`: Repository owner (string, required) - `repo`: Repository name (string, required) - **create_or_update_file** - Create or update file - - `branch`: Branch to create/update the file in (string, required) - `content`: Content of the file (string, required) - `message`: Commit message (string, required) @@ -1025,7 +949,6 @@ The following sets of tools are available (all are on by default): - `sha`: Required if updating an existing file. The blob SHA of the file being replaced. (string, optional) - **create_repository** - Create repository - - `autoInit`: Initialize with README (boolean, optional) - `description`: Repository description (string, optional) - `name`: Repository name (string, required) @@ -1033,7 +956,6 @@ The following sets of tools are available (all are on by default): - `private`: Whether repo should be private (boolean, optional) - **delete_file** - Delete file - - `branch`: Branch to delete the file from (string, required) - `message`: Commit message (string, required) - `owner`: Repository owner (username or organization) (string, required) @@ -1041,13 +963,11 @@ The following sets of tools are available (all are on by default): - `repo`: Repository name (string, required) - **fork_repository** - Fork repository - - `organization`: Organization to fork to (string, optional) - `owner`: Repository owner (string, required) - `repo`: Repository name (string, required) - **get_commit** - Get commit details - - `include_diff`: Whether to include file diffs and stats in the response. Default is true. (boolean, optional) - `owner`: Repository owner (string, required) - `page`: Page number for pagination (min 1) (number, optional) @@ -1056,7 +976,6 @@ The following sets of tools are available (all are on by default): - `sha`: Commit SHA, branch name, or tag name (string, required) - **get_file_contents** - Get file or directory contents - - `owner`: Repository owner (username or organization) (string, required) - `path`: Path to file/directory (directories must end with a slash '/') (string, optional) - `ref`: Accepts optional git refs such as `refs/tags/{tag}`, `refs/heads/{branch}` or `refs/pull/{pr_number}/head` (string, optional) @@ -1064,31 +983,26 @@ The following sets of tools are available (all are on by default): - `sha`: Accepts optional commit SHA. If specified, it will be used instead of ref (string, optional) - **get_latest_release** - Get latest release - - `owner`: Repository owner (string, required) - `repo`: Repository name (string, required) - **get_release_by_tag** - Get a release by tag name - - `owner`: Repository owner (string, required) - `repo`: Repository name (string, required) - `tag`: Tag name (e.g., 'v1.0.0') (string, required) - **get_tag** - Get tag details - - `owner`: Repository owner (string, required) - `repo`: Repository name (string, required) - `tag`: Tag name (string, required) - **list_branches** - List branches - - `owner`: Repository owner (string, required) - `page`: Page number for pagination (min 1) (number, optional) - `perPage`: Results per page for pagination (min 1, max 100) (number, optional) - `repo`: Repository name (string, required) - **list_commits** - List commits - - `author`: Author username or email address to filter commits by (string, optional) - `owner`: Repository owner (string, required) - `page`: Page number for pagination (min 1) (number, optional) @@ -1097,21 +1011,18 @@ The following sets of tools are available (all are on by default): - `sha`: Commit SHA, branch or tag name to list commits of. If not provided, uses the default branch of the repository. If a commit SHA is provided, will list commits up to that SHA. (string, optional) - **list_releases** - List releases - - `owner`: Repository owner (string, required) - `page`: Page number for pagination (min 1) (number, optional) - `perPage`: Results per page for pagination (min 1, max 100) (number, optional) - `repo`: Repository name (string, required) - **list_tags** - List tags - - `owner`: Repository owner (string, required) - `page`: Page number for pagination (min 1) (number, optional) - `perPage`: Results per page for pagination (min 1, max 100) (number, optional) - `repo`: Repository name (string, required) - **push_files** - Push files to repository - - `branch`: Branch to push to (string, required) - `files`: Array of file objects to push, each object with path (string) and content (string) (object[], required) - `message`: Commit message (string, required) @@ -1119,7 +1030,6 @@ The following sets of tools are available (all are on by default): - `repo`: Repository name (string, required) - **search_code** - Search code - - `order`: Sort order for results (string, optional) - `page`: Page number for pagination (min 1) (number, optional) - `perPage`: Results per page for pagination (min 1, max 100) (number, optional) @@ -1141,7 +1051,6 @@ The following sets of tools are available (all are on by default): Secret Protection - **get_secret_scanning_alert** - Get secret scanning alert - - `alertNumber`: The number of the alert. (number, required) - `owner`: The owner of the repository. (string, required) - `repo`: The name of the repository. (string, required) @@ -1160,11 +1069,9 @@ The following sets of tools are available (all are on by default): Security Advisories - **get_global_security_advisory** - Get a global security advisory - - `ghsaId`: GitHub Security Advisory ID (format: GHSA-xxxx-xxxx-xxxx). (string, required) - **list_global_security_advisories** - List global security advisories - - `affects`: Filter advisories by affected package or version (e.g. "package1,package2@1.0.0"). (string, optional) - `cveId`: Filter by CVE ID. (string, optional) - `cwes`: Filter by Common Weakness Enumeration IDs (e.g. ["79", "284", "22"]). (string[], optional) @@ -1178,7 +1085,6 @@ The following sets of tools are available (all are on by default): - `updated`: Filter by update date or date range (ISO 8601 date or range). (string, optional) - **list_org_repository_security_advisories** - List org repository security advisories - - `direction`: Sort direction. (string, optional) - `org`: The organization login. (string, required) - `sort`: Sort field. (string, optional) @@ -1198,7 +1104,6 @@ The following sets of tools are available (all are on by default): Stargazers - **list_starred_repositories** - List starred repositories - - `direction`: The direction to sort the results by. (string, optional) - `page`: Page number for pagination (min 1) (number, optional) - `perPage`: Results per page for pagination (min 1, max 100) (number, optional) @@ -1206,7 +1111,6 @@ The following sets of tools are available (all are on by default): - `username`: Username to list starred repositories for. Defaults to the authenticated user. (string, optional) - **star_repository** - Star repository - - `owner`: Repository owner (string, required) - `repo`: Repository name (string, required) @@ -1236,12 +1140,12 @@ The following sets of tools are available (all are on by default): Copilot coding agent -- **create_pull_request_with_copilot** - Perform task with GitHub Copilot coding agent - - `owner`: Repository owner. You can guess the owner, but confirm it with the user before proceeding. (string, required) - - `repo`: Repository name. You can guess the repository name, but confirm it with the user before proceeding. (string, required) - - `problem_statement`: Detailed description of the task to be performed (e.g., 'Implement a feature that does X', 'Fix bug Y', etc.) (string, required) - - `title`: Title for the pull request that will be created (string, required) - - `base_ref`: Git reference (e.g., branch) that the agent will start its work from. If not specified, defaults to the repository's default branch (string, optional) +- **create_pull_request_with_copilot** - Perform task with GitHub Copilot coding agent + - `owner`: Repository owner. You can guess the owner, but confirm it with the user before proceeding. (string, required) + - `repo`: Repository name. You can guess the repository name, but confirm it with the user before proceeding. (string, required) + - `problem_statement`: Detailed description of the task to be performed (e.g., 'Implement a feature that does X', 'Fix bug Y', etc.) (string, required) + - `title`: Title for the pull request that will be created (string, required) + - `base_ref`: Git reference (e.g., branch) that the agent will start its work from. If not specified, defaults to the repository's default branch (string, optional)
@@ -1249,18 +1153,18 @@ The following sets of tools are available (all are on by default): Copilot Spaces -- **get_copilot_space** - Get Copilot Space - - - `owner`: The owner of the space. (string, required) - - `name`: The name of the space. (string, required) +- **get_copilot_space** - Get Copilot Space + - `owner`: The owner of the space. (string, required) + - `name`: The name of the space. (string, required) -- **list_copilot_spaces** - List Copilot Spaces +- **list_copilot_spaces** - List Copilot Spaces -
-Web Search (note: only available for users on a paid Copilot subscription, and with Web search enabled) +Web Search +> **Note:** Only available for users on a paid Copilot subscription, and with Web search enabled. -- **web_search** - Web Search - `query`: A natural language query representing what to search for on the web. (string, required) +- **web_search** - Web Search + - `query`: A natural language query representing what to search for on the web. (string, required)
## Dynamic Tool Discovery @@ -1310,8 +1214,7 @@ the hostname for GitHub Enterprise Server or GitHub Enterprise Cloud with data r - For GitHub Enterprise Server, prefix the hostname with the `https://` URI scheme, as it otherwise defaults to `http://`, which GitHub Enterprise Server does not support. - For GitHub Enterprise Cloud with data residency, use `https://YOURSUBDOMAIN.ghe.com` as the hostname. - -```json +``` json "github": { "command": "docker", "args": [ From 6998b8aecd9e6f6c6fd12da860090916286305f8 Mon Sep 17 00:00:00 2001 From: tommaso-moro Date: Fri, 10 Oct 2025 10:55:12 +0100 Subject: [PATCH 4/8] update --- README.md | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/README.md b/README.md index da63108bb..50a0c156e 100644 --- a/README.md +++ b/README.md @@ -1161,7 +1161,7 @@ Possible options: Web Search -> **Note:** Only available for users on a paid Copilot subscription, and with Web search enabled. +Note: Only available for users on a paid Copilot subscription, and with Web search enabled. - **web_search** - Web Search - `query`: A natural language query representing what to search for on the web. (string, required) From b8f1af39e648ef00df5350f8545ee1b9f7155101 Mon Sep 17 00:00:00 2001 From: tommaso-moro Date: Fri, 10 Oct 2025 10:56:24 +0100 Subject: [PATCH 5/8] add
--- README.md | 1 + 1 file changed, 1 insertion(+) diff --git a/README.md b/README.md index 50a0c156e..5227cf413 100644 --- a/README.md +++ b/README.md @@ -1160,6 +1160,7 @@ Possible options: - **list_copilot_spaces** - List Copilot Spaces
+
Web Search Note: Only available for users on a paid Copilot subscription, and with Web search enabled. From 775425608631826ff00d615d28988529047b16b2 Mon Sep 17 00:00:00 2001 From: tommaso-moro Date: Fri, 10 Oct 2025 10:57:35 +0100 Subject: [PATCH 6/8] update --- README.md | 3 ++- 1 file changed, 2 insertions(+), 1 deletion(-) diff --git a/README.md b/README.md index 5227cf413..615785598 100644 --- a/README.md +++ b/README.md @@ -1161,8 +1161,9 @@ Possible options:
+ Web Search -Note: Only available for users on a paid Copilot subscription, and with Web search enabled. +> **Note:** Only available for users on a paid Copilot subscription, and with Web search enabled. - **web_search** - Web Search - `query`: A natural language query representing what to search for on the web. (string, required) From 890f1d43baf76579370dafc350dd63c2559b0fd3 Mon Sep 17 00:00:00 2001 From: tommaso-moro Date: Fri, 10 Oct 2025 10:58:16 +0100 Subject: [PATCH 7/8] test diff --- README.md | 2 ++ 1 file changed, 2 insertions(+) diff --git a/README.md b/README.md index 615785598..3e5553a19 100644 --- a/README.md +++ b/README.md @@ -1173,6 +1173,8 @@ Possible options: **Note**: This feature is currently in beta and may not be available in all environments. Please test it out and let us know if you encounter any issues. +Hello world + Instead of starting with all tools enabled, you can turn on dynamic toolset discovery. Dynamic toolsets allow the MCP host to list and enable toolsets in response to a user prompt. This should help to avoid situations where the model gets confused by the sheer number of tools available. ### Using Dynamic Tool Discovery From 53dde14de0fbc1499b02f41b897986ea629be72a Mon Sep 17 00:00:00 2001 From: tommaso-moro Date: Fri, 10 Oct 2025 11:52:44 +0100 Subject: [PATCH 8/8] remove --- README.md | 2 -- 1 file changed, 2 deletions(-) diff --git a/README.md b/README.md index 3e5553a19..615785598 100644 --- a/README.md +++ b/README.md @@ -1173,8 +1173,6 @@ Possible options: **Note**: This feature is currently in beta and may not be available in all environments. Please test it out and let us know if you encounter any issues. -Hello world - Instead of starting with all tools enabled, you can turn on dynamic toolset discovery. Dynamic toolsets allow the MCP host to list and enable toolsets in response to a user prompt. This should help to avoid situations where the model gets confused by the sheer number of tools available. ### Using Dynamic Tool Discovery