You signed in with another tab or window. Reload to refresh your session.You signed out in another tab or window. Reload to refresh your session.You switched accounts on another tab or window. Reload to refresh your session.Dismiss alert
stale-issue-message: "This issue is stale because it has been open for ${{ env.PR_DAYS_BEFORE_STALE }} days with no activity. Leave a comment to avoid closing this issue in ${{ env.PR_DAYS_BEFORE_CLOSE }} days."
23
+
close-issue-message: "This issue was closed because it has been inactive for ${{ env.PR_DAYS_BEFORE_CLOSE }} days since being marked as stale."
Copy file name to clipboardExpand all lines: README.md
+78-14Lines changed: 78 additions & 14 deletions
Display the source diff
Display the rich diff
Original file line number
Diff line number
Diff line change
@@ -36,7 +36,7 @@ Alternatively, to manually configure VS Code, choose the appropriate JSON block
36
36
<tr><thalign=leftcolspan=2>VS Code (version 1.101 or greater)</th></tr>
37
37
<trvalign=top>
38
38
<td>
39
-
39
+
40
40
```json
41
41
{
42
42
"servers": {
@@ -130,7 +130,7 @@ To keep your GitHub PAT secure and reusable across different MCP hosts:
130
130
```bash
131
131
# CLI usage
132
132
claude mcp update github -e GITHUB_PERSONAL_ACCESS_TOKEN=$GITHUB_PAT
133
-
133
+
134
134
# In config files (where supported)
135
135
"env": {
136
136
"GITHUB_PERSONAL_ACCESS_TOKEN": "$GITHUB_PAT"
@@ -144,6 +144,7 @@ To keep your GitHub PAT secure and reusable across different MCP hosts:
144
144
-**Minimum scopes**: Only grant necessary permissions
145
145
-`repo` - Repository operations
146
146
-`read:packages` - Docker image access
147
+
-`read:org` - Organization team access
147
148
-**Separate tokens**: Use different PATs for different projects/environments
148
149
-**Regular rotation**: Update tokens periodically
149
150
-**Never commit**: Keep tokens out of version control
@@ -240,10 +241,10 @@ For other MCP host applications, please refer to our installation guides:
240
241
241
242
-**[GitHub Copilot in other IDEs](/docs/installation-guides/install-other-copilot-ides.md)** - Installation for JetBrains, Visual Studio, Eclipse, and Xcode with GitHub Copilot
242
243
-**[Claude Code & Claude Desktop](docs/installation-guides/install-claude.md)** - Installation guide for Claude Code and Claude Desktop
243
-
-**[Cursor](docs/installation-guides/install-cursor.md)** - Installation guide for Cursor IDE
244
+
-**[Cursor](docs/installation-guides/install-cursor.md)** - Installation guide for Cursor IDE
244
245
-**[Windsurf](docs/installation-guides/install-windsurf.md)** - Installation guide for Windsurf IDE
245
246
246
-
For a complete overview of all installation options, see our **[Installation Guides Index](docs/installation-guides/installation-guides.md)**.
247
+
For a complete overview of all installation options, see our **[Installation Guides Index](docs/installation-guides)**.
247
248
248
249
> **Note:** Any host application that supports local MCP servers should be able to access the local GitHub MCP server. However, the specific configuration process, syntax and stability of the integration will vary by host application. While many may follow a similar format to the examples above, this is not guaranteed. Please refer to your host application's documentation for the correct MCP configuration syntax and setup process.
249
250
@@ -294,6 +295,7 @@ The following sets of tools are available (all are on by default):
294
295
|`pull_requests`| GitHub Pull Request related tools |
295
296
|`repos`| GitHub Repository related tools |
296
297
|`secret_protection`| Secret protection related tools, such as GitHub Secret Scanning |
298
+
|`security_advisories`| Security advisories related tools |
297
299
|`users`| GitHub User related tools |
298
300
<!-- END AUTOMATED TOOLSETS -->
299
301
@@ -421,6 +423,13 @@ The following sets of tools are available (all are on by default):
421
423
-**get_me** - Get my user profile
422
424
- No parameters required
423
425
426
+
-**get_team_members** - Get team members
427
+
-`org`: Organization login (owner) that contains the team. (string, required)
428
+
-`team_slug`: Team slug (string, required)
429
+
430
+
-**get_teams** - Get teams
431
+
-`user`: Username to get teams for. If not provided, uses the authenticated user. (string, optional)
432
+
424
433
</details>
425
434
426
435
<details>
@@ -458,7 +467,7 @@ The following sets of tools are available (all are on by default):
458
467
459
468
-**list_discussion_categories** - List discussion categories
460
469
-`owner`: Repository owner (string, required)
461
-
-`repo`: Repository name(string, required)
470
+
-`repo`: Repository name. If not provided, discussion categories will be queried at the organisation level. (string, optional)
462
471
463
472
-**list_discussions** - List discussions
464
473
-`after`: Cursor for pagination. Use the endCursor from the previous page's PageInfo for GraphQL APIs. (string, optional)
@@ -525,6 +534,7 @@ The following sets of tools are available (all are on by default):
525
534
-`owner`: Repository owner (string, required)
526
535
-`repo`: Repository name (string, required)
527
536
-`title`: Issue title (string, required)
537
+
-`type`: Type of this issue (string, optional)
528
538
529
539
-**get_issue** - Get issue details
530
540
-`issue_number`: The number of the issue (number, required)
@@ -557,16 +567,19 @@ The following sets of tools are available (all are on by default):
557
567
-`perPage`: Results per page for pagination (min 1, max 100) (number, optional)
558
568
-`repo`: Repository name (string, required)
559
569
570
+
-**list_issue_types** - List available issue types
571
+
-`owner`: The organization owner of the repository (string, required)
572
+
560
573
-**list_issues** - List issues
561
-
-`direction`: Sort direction (string, optional)
574
+
-`after`: Cursor for pagination. Use the endCursor from the previous page's PageInfo for GraphQL APIs. (string, optional)
575
+
-`direction`: Order direction. If provided, the 'orderBy' also needs to be provided. (string, optional)
562
576
-`labels`: Filter by labels (string[], optional)
577
+
-`orderBy`: Order issues by field. If provided, the 'direction' also needs to be provided. (string, optional)
563
578
-`owner`: Repository owner (string, required)
564
-
-`page`: Page number for pagination (min 1) (number, optional)
565
579
-`perPage`: Results per page for pagination (min 1, max 100) (number, optional)
566
580
-`repo`: Repository name (string, required)
567
581
-`since`: Filter by date (ISO 8601 timestamp) (string, optional)
568
-
-`sort`: Sort order (string, optional)
569
-
-`state`: Filter by state (string, optional)
582
+
-`state`: Filter by state, by default both open and closed issues are returned when not provided (string, optional)
570
583
571
584
-**list_sub_issues** - List sub-issues
572
585
-`issue_number`: Issue number (number, required)
@@ -591,11 +604,11 @@ The following sets of tools are available (all are on by default):
591
604
592
605
-**search_issues** - Search issues
593
606
-`order`: Sort order (string, optional)
594
-
-`owner`: Optional repository owner. If provided with repo, only notifications for this repository are listed. (string, optional)
607
+
-`owner`: Optional repository owner. If provided with repo, only issues for this repository are listed. (string, optional)
595
608
-`page`: Page number for pagination (min 1) (number, optional)
596
609
-`perPage`: Results per page for pagination (min 1, max 100) (number, optional)
597
610
-`query`: Search query using GitHub issues search syntax (string, required)
598
-
-`repo`: Optional repository name. If provided with owner, only notifications for this repository are listed. (string, optional)
611
+
-`repo`: Optional repository name. If provided with owner, only issues for this repository are listed. (string, optional)
599
612
-`sort`: Sort field by number of matches of categories, defaults to best match (string, optional)
600
613
601
614
-**update_issue** - Edit issue
@@ -608,6 +621,7 @@ The following sets of tools are available (all are on by default):
608
621
-`repo`: Repository name (string, required)
609
622
-`state`: New state (string, optional)
610
623
-`title`: New title (string, optional)
624
+
-`type`: New issue type (string, optional)
611
625
612
626
</details>
613
627
@@ -763,11 +777,11 @@ The following sets of tools are available (all are on by default):
763
777
764
778
-**search_pull_requests** - Search pull requests
765
779
-`order`: Sort order (string, optional)
766
-
-`owner`: Optional repository owner. If provided with repo, only notifications for this repository are listed. (string, optional)
780
+
-`owner`: Optional repository owner. If provided with repo, only pull requests for this repository are listed. (string, optional)
767
781
-`page`: Page number for pagination (min 1) (number, optional)
768
782
-`perPage`: Results per page for pagination (min 1, max 100) (number, optional)
-`repo`: Optional repository name. If provided with owner, only notifications for this repository are listed. (string, optional)
784
+
-`repo`: Optional repository name. If provided with owner, only pull requests for this repository are listed. (string, optional)
771
785
-`sort`: Sort field by number of matches of categories, defaults to best match (string, optional)
772
786
773
787
-**submit_pending_pull_request_review** - Submit the requester's latest pending pull request review
@@ -848,6 +862,15 @@ The following sets of tools are available (all are on by default):
848
862
-`repo`: Repository name (string, required)
849
863
-`sha`: Accepts optional commit SHA. If specified, it will be used instead of ref (string, optional)
850
864
865
+
-**get_latest_release** - Get latest release
866
+
-`owner`: Repository owner (string, required)
867
+
-`repo`: Repository name (string, required)
868
+
869
+
-**get_release_by_tag** - Get a release by tag name
870
+
-`owner`: Repository owner (string, required)
871
+
-`repo`: Repository name (string, required)
872
+
-`tag`: Tag name (e.g., 'v1.0.0') (string, required)
873
+
851
874
-**get_tag** - Get tag details
852
875
-`owner`: Repository owner (string, required)
853
876
-`repo`: Repository name (string, required)
@@ -867,6 +890,12 @@ The following sets of tools are available (all are on by default):
867
890
-`repo`: Repository name (string, required)
868
891
-`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)
869
892
893
+
-**list_releases** - List releases
894
+
-`owner`: Repository owner (string, required)
895
+
-`page`: Page number for pagination (min 1) (number, optional)
896
+
-`perPage`: Results per page for pagination (min 1, max 100) (number, optional)
897
+
-`repo`: Repository name (string, required)
898
+
870
899
-**list_tags** - List tags
871
900
-`owner`: Repository owner (string, required)
872
901
-`page`: Page number for pagination (min 1) (number, optional)
@@ -914,6 +943,41 @@ The following sets of tools are available (all are on by default):
914
943
915
944
<details>
916
945
946
+
<summary>Security Advisories</summary>
947
+
948
+
-**get_global_security_advisory** - Get a global security advisory
949
+
-`ghsaId`: GitHub Security Advisory ID (format: GHSA-xxxx-xxxx-xxxx). (string, required)
950
+
951
+
-**list_global_security_advisories** - List global security advisories
952
+
-`affects`: Filter advisories by affected package or version (e.g. "package1,package2@1.0.0"). (string, optional)
953
+
-`cveId`: Filter by CVE ID. (string, optional)
954
+
-`cwes`: Filter by Common Weakness Enumeration IDs (e.g. ["79", "284", "22"]). (string[], optional)
955
+
-`ecosystem`: Filter by package ecosystem. (string, optional)
956
+
-`ghsaId`: Filter by GitHub Security Advisory ID (format: GHSA-xxxx-xxxx-xxxx). (string, optional)
957
+
-`isWithdrawn`: Whether to only return withdrawn advisories. (boolean, optional)
958
+
-`modified`: Filter by publish or update date or date range (ISO 8601 date or range). (string, optional)
959
+
-`published`: Filter by publish date or date range (ISO 8601 date or range). (string, optional)
960
+
-`severity`: Filter by severity. (string, optional)
961
+
-`type`: Advisory type. (string, optional)
962
+
-`updated`: Filter by update date or date range (ISO 8601 date or range). (string, optional)
963
+
964
+
-**list_org_repository_security_advisories** - List org repository security advisories
965
+
-`direction`: Sort direction. (string, optional)
966
+
-`org`: The organization login. (string, required)
967
+
-`sort`: Sort field. (string, optional)
968
+
-`state`: Filter by advisory state. (string, optional)
969
+
970
+
-**list_repository_security_advisories** - List repository security advisories
971
+
-`direction`: Sort direction. (string, optional)
972
+
-`owner`: The owner of the repository. (string, required)
973
+
-`repo`: The name of the repository. (string, required)
974
+
-`sort`: Sort field. (string, optional)
975
+
-`state`: Filter by advisory state. (string, optional)
976
+
977
+
</details>
978
+
979
+
<details>
980
+
917
981
<summary>Users</summary>
918
982
919
983
-**search_users** - Search users
@@ -1094,4 +1158,4 @@ The exported Go API of this module should currently be considered unstable, and
1094
1158
1095
1159
## License
1096
1160
1097
-
This project is licensed under the terms of the MIT open source license. Please refer to [MIT](./LICENSE) for the full terms.
1161
+
This project is licensed under the terms of the MIT open source license. Please refer to [MIT](./LICENSE) for the full terms.
rootCmd.PersistentFlags().Bool("enable-command-logging", false, "When enabled, the server will log all command requests and responses to the log file")
76
77
rootCmd.PersistentFlags().Bool("export-translations", false, "Save translations to a JSON file")
77
78
rootCmd.PersistentFlags().String("gh-host", "", "Specify the GitHub hostname (for GitHub Enterprise etc.)")
79
+
rootCmd.PersistentFlags().Int("content-window-size", 5000, "Specify the content window size")
0 commit comments