Skip to content

Commit 7edb968

Browse files
LuluBeatsonLuluBeatson
committed
revert docs changes
1 parent 1b45204 commit 7edb968

File tree

2 files changed

+254
-5
lines changed

2 files changed

+254
-5
lines changed

‎README.md‎

Lines changed: 249 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -398,15 +398,20 @@ The following sets of tools are available:
398398
| `code_security` | Code security related tools, such as GitHub Code Scanning |
399399
| `dependabot` | Dependabot tools |
400400
| `discussions` | GitHub Discussions related tools |
401+
| `experiments` | Experimental features that are not considered stable yet |
401402
| `gists` | GitHub Gist related tools |
402403
| `git` | GitHub Git API related tools for low-level Git operations |
403404
| `issues` | GitHub Issues related tools |
404405
| `labels` | GitHub Labels related tools |
405406
| `notifications` | GitHub Notifications related tools |
407+
| `orgs` | GitHub Organization related tools |
408+
| `projects` | GitHub Projects related tools |
406409
| `pull_requests` | GitHub Pull Request related tools |
407410
| `repos` | GitHub Repository related tools |
408411
| `secret_protection` | Secret protection related tools, such as GitHub Secret Scanning |
409412
| `security_advisories` | Security advisories related tools |
413+
| `stargazers` | GitHub Stargazers related tools |
414+
| `users` | GitHub User related tools |
410415
<!-- END AUTOMATED TOOLSETS -->
411416

412417
### Additional Toolsets in Remote GitHub MCP Server
@@ -652,10 +657,15 @@ The following sets of tools are available:
652657
- `owner`: Repository owner (string, required)
653658
- `repo`: Repository name (string, required)
654659

660+
- **get_label** - Get a specific label from a repository.
661+
- `name`: Label name. (string, required)
662+
- `owner`: Repository owner (username or organization name) (string, required)
663+
- `repo`: Repository name (string, required)
664+
655665
- **issue_read** - Get issue details
656666
- `issue_number`: The number of the issue (number, required)
657-
- `method`: The read operation to perform on a single issue.
658-
Options are:
667+
- `method`: The read operation to perform on a single issue.
668+
Options are:
659669
1. get - Get details of a specific issue.
660670
2. get_comments - Get issue comments.
661671
3. get_sub_issues - Get sub-issues of the issue.
@@ -673,8 +683,8 @@ Options are:
673683
- `issue_number`: Issue number to update (number, optional)
674684
- `labels`: Labels to apply to this issue (string[], optional)
675685
- `method`: Write operation to perform on a single issue.
676-
Options are:
677-
- 'create' - creates a new issue.
686+
Options are:
687+
- 'create' - creates a new issue.
678688
- 'update' - updates an existing issue.
679689
(string, required)
680690
- `milestone`: Milestone number (number, optional)
@@ -754,7 +764,7 @@ Options are:
754764
<summary>Notifications</summary>
755765

756766
- **dismiss_notification** - Dismiss notification
757-
- `state`: The new state of the notification (read/done) (string, required)
767+
- `state`: The new state of the notification (read/done) (string, optional)
758768
- `threadID`: The ID of the notification thread (string, required)
759769

760770
- **get_notification_details** - Get notification details
@@ -787,6 +797,89 @@ Options are:
787797

788798
<details>
789799

800+
<summary>Organizations</summary>
801+
802+
- **search_orgs** - Search organizations
803+
- `order`: Sort order (string, optional)
804+
- `page`: Page number for pagination (min 1) (number, optional)
805+
- `perPage`: Results per page for pagination (min 1, max 100) (number, optional)
806+
- `query`: Organization search query. Examples: 'microsoft', 'location:california', 'created:>=2025-01-01'. Search is automatically scoped to type:org. (string, required)
807+
- `sort`: Sort field by category (string, optional)
808+
809+
</details>
810+
811+
<details>
812+
813+
<summary>Projects</summary>
814+
815+
- **add_project_item** - Add project item
816+
- `item_id`: The numeric ID of the issue or pull request to add to the project. (number, required)
817+
- `item_type`: The item's type, either issue or pull_request. (string, required)
818+
- `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)
819+
- `owner_type`: Owner type (string, required)
820+
- `project_number`: The project's number. (number, required)
821+
822+
- **delete_project_item** - Delete project item
823+
- `item_id`: The internal project item ID to delete from the project (not the issue or pull request ID). (number, required)
824+
- `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)
825+
- `owner_type`: Owner type (string, required)
826+
- `project_number`: The project's number. (number, required)
827+
828+
- **get_project** - Get project
829+
- `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)
830+
- `owner_type`: Owner type (string, required)
831+
- `project_number`: The project's number (number, required)
832+
833+
- **get_project_field** - Get project field
834+
- `field_id`: The field's id. (number, required)
835+
- `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)
836+
- `owner_type`: Owner type (string, required)
837+
- `project_number`: The project's number. (number, required)
838+
839+
- **get_project_item** - Get project item
840+
- `fields`: Specific list of field IDs to include in the response (e.g. ["102589", "985201", "169875"]). If not provided, only the title field is included. (string[], optional)
841+
- `item_id`: The item's ID. (number, required)
842+
- `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)
843+
- `owner_type`: Owner type (string, required)
844+
- `project_number`: The project's number. (number, required)
845+
846+
- **list_project_fields** - List project fields
847+
- `after`: Forward pagination cursor from previous pageInfo.nextCursor. (string, optional)
848+
- `before`: Backward pagination cursor from previous pageInfo.prevCursor (rare). (string, optional)
849+
- `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)
850+
- `owner_type`: Owner type (string, required)
851+
- `per_page`: Results per page (max 50) (number, optional)
852+
- `project_number`: The project's number. (number, required)
853+
854+
- **list_project_items** - List project items
855+
- `after`: Forward pagination cursor from previous pageInfo.nextCursor. (string, optional)
856+
- `before`: Backward pagination cursor from previous pageInfo.prevCursor (rare). (string, optional)
857+
- `fields`: Field IDs to include (e.g. ["102589", "985201"]). CRITICAL: Always provide to get field values. Without this, only titles returned. (string[], optional)
858+
- `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)
859+
- `owner_type`: Owner type (string, required)
860+
- `per_page`: Results per page (max 50) (number, optional)
861+
- `project_number`: The project's number. (number, required)
862+
- `query`: Query string for advanced filtering of project items using GitHub's project filtering syntax. (string, optional)
863+
864+
- **list_projects** - List projects
865+
- `after`: Forward pagination cursor from previous pageInfo.nextCursor. (string, optional)
866+
- `before`: Backward pagination cursor from previous pageInfo.prevCursor (rare). (string, optional)
867+
- `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)
868+
- `owner_type`: Owner type (string, required)
869+
- `per_page`: Results per page (max 50) (number, optional)
870+
- `query`: Filter projects by title text and open/closed state; permitted qualifiers: is:open, is:closed; examples: "roadmap is:open", "is:open feature planning". (string, optional)
871+
872+
- **update_project_item** - Update project item
873+
- `item_id`: The unique identifier of the project item. This is not the issue or pull request ID. (number, required)
874+
- `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)
875+
- `owner_type`: Owner type (string, required)
876+
- `project_number`: The project's number. (number, required)
877+
- `updated_field`: Object consisting of the ID of the project field to update and the new value for the field. To clear the field, set value to null. Example: {"id": 123456, "value": "New Value"} (object, required)
878+
879+
</details>
880+
881+
<details>
882+
790883
<summary>Pull Requests</summary>
791884

792885
- **add_comment_to_pending_review** - Add review comment to the requester's latest pending pull request review
@@ -892,6 +985,123 @@ Possible options:
892985

893986
<details>
894987

988+
<summary>Repositories</summary>
989+
990+
- **create_branch** - Create branch
991+
- `branch`: Name for new branch (string, required)
992+
- `from_branch`: Source branch (defaults to repo default) (string, optional)
993+
- `owner`: Repository owner (string, required)
994+
- `repo`: Repository name (string, required)
995+
996+
- **create_or_update_file** - Create or update file
997+
- `branch`: Branch to create/update the file in (string, required)
998+
- `content`: Content of the file (string, required)
999+
- `message`: Commit message (string, required)
1000+
- `owner`: Repository owner (username or organization) (string, required)
1001+
- `path`: Path where to create/update the file (string, required)
1002+
- `repo`: Repository name (string, required)
1003+
- `sha`: Required if updating an existing file. The blob SHA of the file being replaced. (string, optional)
1004+
1005+
- **create_repository** - Create repository
1006+
- `autoInit`: Initialize with README (boolean, optional)
1007+
- `description`: Repository description (string, optional)
1008+
- `name`: Repository name (string, required)
1009+
- `organization`: Organization to create the repository in (omit to create in your personal account) (string, optional)
1010+
- `private`: Whether repo should be private (boolean, optional)
1011+
1012+
- **delete_file** - Delete file
1013+
- `branch`: Branch to delete the file from (string, required)
1014+
- `message`: Commit message (string, required)
1015+
- `owner`: Repository owner (username or organization) (string, required)
1016+
- `path`: Path to the file to delete (string, required)
1017+
- `repo`: Repository name (string, required)
1018+
1019+
- **fork_repository** - Fork repository
1020+
- `organization`: Organization to fork to (string, optional)
1021+
- `owner`: Repository owner (string, required)
1022+
- `repo`: Repository name (string, required)
1023+
1024+
- **get_commit** - Get commit details
1025+
- `include_diff`: Whether to include file diffs and stats in the response. Default is true. (boolean, optional)
1026+
- `owner`: Repository owner (string, required)
1027+
- `page`: Page number for pagination (min 1) (number, optional)
1028+
- `perPage`: Results per page for pagination (min 1, max 100) (number, optional)
1029+
- `repo`: Repository name (string, required)
1030+
- `sha`: Commit SHA, branch name, or tag name (string, required)
1031+
1032+
- **get_file_contents** - Get file or directory contents
1033+
- `owner`: Repository owner (username or organization) (string, required)
1034+
- `path`: Path to file/directory (directories must end with a slash '/') (string, optional)
1035+
- `ref`: Accepts optional git refs such as `refs/tags/{tag}`, `refs/heads/{branch}` or `refs/pull/{pr_number}/head` (string, optional)
1036+
- `repo`: Repository name (string, required)
1037+
- `sha`: Accepts optional commit SHA. If specified, it will be used instead of ref (string, optional)
1038+
1039+
- **get_latest_release** - Get latest release
1040+
- `owner`: Repository owner (string, required)
1041+
- `repo`: Repository name (string, required)
1042+
1043+
- **get_release_by_tag** - Get a release by tag name
1044+
- `owner`: Repository owner (string, required)
1045+
- `repo`: Repository name (string, required)
1046+
- `tag`: Tag name (e.g., 'v1.0.0') (string, required)
1047+
1048+
- **get_tag** - Get tag details
1049+
- `owner`: Repository owner (string, required)
1050+
- `repo`: Repository name (string, required)
1051+
- `tag`: Tag name (string, required)
1052+
1053+
- **list_branches** - List branches
1054+
- `owner`: Repository owner (string, required)
1055+
- `page`: Page number for pagination (min 1) (number, optional)
1056+
- `perPage`: Results per page for pagination (min 1, max 100) (number, optional)
1057+
- `repo`: Repository name (string, required)
1058+
1059+
- **list_commits** - List commits
1060+
- `author`: Author username or email address to filter commits by (string, optional)
1061+
- `owner`: Repository owner (string, required)
1062+
- `page`: Page number for pagination (min 1) (number, optional)
1063+
- `perPage`: Results per page for pagination (min 1, max 100) (number, optional)
1064+
- `repo`: Repository name (string, required)
1065+
- `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)
1066+
1067+
- **list_releases** - List releases
1068+
- `owner`: Repository owner (string, required)
1069+
- `page`: Page number for pagination (min 1) (number, optional)
1070+
- `perPage`: Results per page for pagination (min 1, max 100) (number, optional)
1071+
- `repo`: Repository name (string, required)
1072+
1073+
- **list_tags** - List tags
1074+
- `owner`: Repository owner (string, required)
1075+
- `page`: Page number for pagination (min 1) (number, optional)
1076+
- `perPage`: Results per page for pagination (min 1, max 100) (number, optional)
1077+
- `repo`: Repository name (string, required)
1078+
1079+
- **push_files** - Push files to repository
1080+
- `branch`: Branch to push to (string, required)
1081+
- `files`: Array of file objects to push, each object with path (string) and content (string) (object[], required)
1082+
- `message`: Commit message (string, required)
1083+
- `owner`: Repository owner (string, required)
1084+
- `repo`: Repository name (string, required)
1085+
1086+
- **search_code** - Search code
1087+
- `order`: Sort order for results (string, optional)
1088+
- `page`: Page number for pagination (min 1) (number, optional)
1089+
- `perPage`: Results per page for pagination (min 1, max 100) (number, optional)
1090+
- `query`: Search query using GitHub's powerful code search syntax. Examples: 'content:Skill language:Java org:github', 'NOT is:archived language:Python OR language:go', 'repo:github/github-mcp-server'. Supports exact matching, language filters, path filters, and more. (string, required)
1091+
- `sort`: Sort field ('indexed' only) (string, optional)
1092+
1093+
- **search_repositories** - Search repositories
1094+
- `minimal_output`: Return minimal repository information (default: true). When false, returns full GitHub API repository objects. (boolean, optional)
1095+
- `order`: Sort order (string, optional)
1096+
- `page`: Page number for pagination (min 1) (number, optional)
1097+
- `perPage`: Results per page for pagination (min 1, max 100) (number, optional)
1098+
- `query`: Repository search query. Examples: 'machine learning in:name stars:>1000 language:python', 'topic:react', 'user:facebook'. Supports advanced search syntax for precise filtering. (string, required)
1099+
- `sort`: Sort repositories by field, defaults to best match (string, optional)
1100+
1101+
</details>
1102+
1103+
<details>
1104+
8951105
<summary>Secret Protection</summary>
8961106

8971107
- **get_secret_scanning_alert** - Get secret scanning alert
@@ -941,6 +1151,40 @@ Possible options:
9411151
- `sort`: Sort field. (string, optional)
9421152
- `state`: Filter by advisory state. (string, optional)
9431153

1154+
</details>
1155+
1156+
<details>
1157+
1158+
<summary>Stargazers</summary>
1159+
1160+
- **list_starred_repositories** - List starred repositories
1161+
- `direction`: The direction to sort the results by. (string, optional)
1162+
- `page`: Page number for pagination (min 1) (number, optional)
1163+
- `perPage`: Results per page for pagination (min 1, max 100) (number, optional)
1164+
- `sort`: How to sort the results. Can be either 'created' (when the repository was starred) or 'updated' (when the repository was last pushed to). (string, optional)
1165+
- `username`: Username to list starred repositories for. Defaults to the authenticated user. (string, optional)
1166+
1167+
- **star_repository** - Star repository
1168+
- `owner`: Repository owner (string, required)
1169+
- `repo`: Repository name (string, required)
1170+
1171+
- **unstar_repository** - Unstar repository
1172+
- `owner`: Repository owner (string, required)
1173+
- `repo`: Repository name (string, required)
1174+
1175+
</details>
1176+
1177+
<details>
1178+
1179+
<summary>Users</summary>
1180+
1181+
- **search_users** - Search users
1182+
- `order`: Sort order (string, optional)
1183+
- `page`: Page number for pagination (min 1) (number, optional)
1184+
- `perPage`: Results per page for pagination (min 1, max 100) (number, optional)
1185+
- `query`: User search query. Examples: 'john smith', 'location:seattle', 'followers:>100'. Search is automatically scoped to type:user. (string, required)
1186+
- `sort`: Sort users by number of followers or repositories, or when the person joined GitHub. (string, optional)
1187+
9441188
</details>
9451189
<!-- END AUTOMATED TOOLS -->
9461190

0 commit comments

Comments
 (0)