Skip to content

Commit 28415cf

Browse files
committed
update docs
1 parent 41fb3da commit 28415cf

File tree

2 files changed

+81
-144
lines changed

2 files changed

+81
-144
lines changed

README.md

Lines changed: 78 additions & 141 deletions
Original file line numberDiff line numberDiff line change
@@ -401,18 +401,15 @@ The following sets of tools are available (all are on by default):
401401

402402
<summary>Code Security</summary>
403403

404-
- **get_code_scanning_alert** - Get code scanning alert
405-
- `alertNumber`: The number of the alert. (number, required)
406-
- `owner`: The owner of the repository. (string, required)
407-
- `repo`: The name of the repository. (string, required)
408-
409-
- **list_code_scanning_alerts** - List code scanning alerts
410-
- `owner`: The owner of the repository. (string, required)
411-
- `ref`: The Git reference for the results you want to list. (string, optional)
412-
- `repo`: The name of the repository. (string, required)
413-
- `severity`: Filter code scanning alerts by severity (string, optional)
414-
- `state`: Filter code scanning alerts by state. Defaults to open (string, optional)
415-
- `tool_name`: The name of the tool used for code scanning. (string, optional)
404+
- **manage_code_scanning_alerts** - Manage Code Scanning Alerts
405+
- `alertNumber`: The number of the alert (required for 'get' operation) (number, optional)
406+
- `operation`: Operation to perform: 'list', 'get' (string, required)
407+
- `owner`: The owner of the repository (string, required)
408+
- `ref`: The Git reference for the results you want to list (used for 'list' operation) (string, optional)
409+
- `repo`: The name of the repository (string, required)
410+
- `severity`: Filter code scanning alerts by severity (used for 'list' operation) (string, optional)
411+
- `state`: Filter code scanning alerts by state (used for 'list' operation) (string, optional)
412+
- `tool_name`: The name of the tool used for code scanning (used for 'list' operation) (string, optional)
416413

417414
</details>
418415

@@ -484,36 +481,24 @@ The following sets of tools are available (all are on by default):
484481

485482
<summary>Gists</summary>
486483

487-
- **create_gist** - Create Gist
488-
- `content`: Content for simple single-file gist creation (string, required)
489-
- `description`: Description of the gist (string, optional)
490-
- `filename`: Filename for simple single-file gist creation (string, required)
491-
- `public`: Whether the gist is public (boolean, optional)
492-
493-
- **list_gists** - List Gists
484+
- **manage_gist** - Manage Gist
485+
- `content`: Content for gist file (required for 'create' and 'update' operations) (string, optional)
486+
- `description`: Description of the gist (used for 'create' and 'update' operations) (string, optional)
487+
- `filename`: Filename for gist file (required for 'create' and 'update' operations) (string, optional)
488+
- `gist_id`: ID of the gist (required for 'update' and 'get' operations) (string, optional)
489+
- `operation`: Operation to perform: 'list', 'create', 'update', 'get' (string, required)
494490
- `page`: Page number for pagination (min 1) (number, optional)
495491
- `perPage`: Results per page for pagination (min 1, max 100) (number, optional)
496-
- `since`: Only gists updated after this time (ISO 8601 timestamp) (string, optional)
497-
- `username`: GitHub username (omit for authenticated user's gists) (string, optional)
498-
499-
- **update_gist** - Update Gist
500-
- `content`: Content for the file (string, required)
501-
- `description`: Updated description of the gist (string, optional)
502-
- `filename`: Filename to update or create (string, required)
503-
- `gist_id`: ID of the gist to update (string, required)
492+
- `public`: Whether the gist is public (used for 'create' operation) (boolean, optional)
493+
- `since`: Only gists updated after this time (ISO 8601 timestamp, used for 'list' operation) (string, optional)
494+
- `username`: GitHub username (omit for authenticated user's gists, used for 'list' and 'get' operations) (string, optional)
504495

505496
</details>
506497

507498
<details>
508499

509500
<summary>Issues</summary>
510501

511-
- **add_issue_comment** - Add comment to issue
512-
- `body`: Comment content (string, required)
513-
- `issue_number`: Issue number to comment on (number, required)
514-
- `owner`: Repository owner (string, required)
515-
- `repo`: Repository name (string, required)
516-
517502
- **add_sub_issue** - Add sub-issue
518503
- `issue_number`: The number of the parent issue (number, required)
519504
- `owner`: Repository owner (string, required)
@@ -526,21 +511,6 @@ The following sets of tools are available (all are on by default):
526511
- `owner`: Repository owner (string, required)
527512
- `repo`: Repository name (string, required)
528513

529-
- **create_issue** - Open new issue
530-
- `assignees`: Usernames to assign to this issue (string[], optional)
531-
- `body`: Issue body content (string, optional)
532-
- `labels`: Labels to apply to this issue (string[], optional)
533-
- `milestone`: Milestone number (number, optional)
534-
- `owner`: Repository owner (string, required)
535-
- `repo`: Repository name (string, required)
536-
- `title`: Issue title (string, required)
537-
- `type`: Type of this issue (string, optional)
538-
539-
- **get_issue** - Get issue details
540-
- `issue_number`: The number of the issue (number, required)
541-
- `owner`: The owner of the repository (string, required)
542-
- `repo`: The name of the repository (string, required)
543-
544514
- **get_issue_comments** - Get issue comments
545515
- `issue_number`: Issue number (number, required)
546516
- `owner`: Repository owner (string, required)
@@ -551,24 +521,33 @@ The following sets of tools are available (all are on by default):
551521
- **list_issue_types** - List available issue types
552522
- `owner`: The organization owner of the repository (string, required)
553523

554-
- **list_issues** - List issues
555-
- `after`: Cursor for pagination. Use the endCursor from the previous page's PageInfo for GraphQL APIs. (string, optional)
556-
- `direction`: Order direction. If provided, the 'orderBy' also needs to be provided. (string, optional)
557-
- `labels`: Filter by labels (string[], optional)
558-
- `orderBy`: Order issues by field. If provided, the 'direction' also needs to be provided. (string, optional)
559-
- `owner`: Repository owner (string, required)
560-
- `perPage`: Results per page for pagination (min 1, max 100) (number, optional)
561-
- `repo`: Repository name (string, required)
562-
- `since`: Filter by date (ISO 8601 timestamp) (string, optional)
563-
- `state`: Filter by state, by default both open and closed issues are returned when not provided (string, optional)
564-
565524
- **list_sub_issues** - List sub-issues
566525
- `issue_number`: Issue number (number, required)
567526
- `owner`: Repository owner (string, required)
568527
- `page`: Page number for pagination (default: 1) (number, optional)
569528
- `per_page`: Number of results per page (max 100, default: 30) (number, optional)
570529
- `repo`: Repository name (string, required)
571530

531+
- **manage_issue** - Manage Issue
532+
- `assignees`: Usernames to assign to this issue (used for 'create', 'update' operations) (string[], optional)
533+
- `body`: Issue body content (used for 'create', 'update', 'add_comment' operations) (string, optional)
534+
- `direction`: Order direction for list operation: 'ASC', 'DESC' (string, optional)
535+
- `issue_number`: Issue number (required for 'get', 'update', 'add_comment' operations) (number, optional)
536+
- `labels`: Labels to apply to this issue (used for 'create', 'update' operations) (string[], optional)
537+
- `list_labels`: Filter by labels for list operation (string[], optional)
538+
- `list_state`: Filter by state for list operation: 'OPEN', 'CLOSED' (string, optional)
539+
- `milestone`: Milestone number (used for 'create', 'update' operations) (number, optional)
540+
- `operation`: Operation to perform: 'list', 'get', 'create', 'update', 'add_comment' (string, required)
541+
- `orderBy`: Order issues by field for list operation: 'CREATED_AT', 'UPDATED_AT', 'COMMENTS' (string, optional)
542+
- `owner`: Repository owner (string, required)
543+
- `page`: Page number for pagination (min 1) (number, optional)
544+
- `perPage`: Results per page for pagination (min 1, max 100) (number, optional)
545+
- `repo`: Repository name (string, required)
546+
- `since`: Filter by date (ISO 8601 timestamp, used for 'list' operation) (string, optional)
547+
- `state`: Issue state (used for 'update' operation): 'open' or 'closed' (string, optional)
548+
- `title`: Issue title (required for 'create' operation) (string, optional)
549+
- `type`: Type of this issue (used for 'create' operation) (string, optional)
550+
572551
- **remove_sub_issue** - Remove sub-issue
573552
- `issue_number`: The number of the parent issue (number, required)
574553
- `owner`: Repository owner (string, required)
@@ -592,18 +571,6 @@ The following sets of tools are available (all are on by default):
592571
- `repo`: Optional repository name. If provided with owner, only issues for this repository are listed. (string, optional)
593572
- `sort`: Sort field by number of matches of categories, defaults to best match (string, optional)
594573

595-
- **update_issue** - Edit issue
596-
- `assignees`: New assignees (string[], optional)
597-
- `body`: New description (string, optional)
598-
- `issue_number`: Issue number to update (number, required)
599-
- `labels`: New labels (string[], optional)
600-
- `milestone`: New milestone number (number, optional)
601-
- `owner`: Repository owner (string, required)
602-
- `repo`: Repository name (string, required)
603-
- `state`: New state (string, optional)
604-
- `title`: New title (string, optional)
605-
- `type`: New issue type (string, optional)
606-
607574
</details>
608575

609576
<details>
@@ -685,26 +652,11 @@ The following sets of tools are available (all are on by default):
685652
- `pullNumber`: Pull request number (number, required)
686653
- `repo`: Repository name (string, required)
687654

688-
- **create_pull_request** - Open new pull request
689-
- `base`: Branch to merge into (string, required)
690-
- `body`: PR description (string, optional)
691-
- `draft`: Create as draft PR (boolean, optional)
692-
- `head`: Branch containing changes (string, required)
693-
- `maintainer_can_modify`: Allow maintainer edits (boolean, optional)
694-
- `owner`: Repository owner (string, required)
695-
- `repo`: Repository name (string, required)
696-
- `title`: PR title (string, required)
697-
698655
- **delete_pending_pull_request_review** - Delete the requester's latest pending pull request review
699656
- `owner`: Repository owner (string, required)
700657
- `pullNumber`: Pull request number (number, required)
701658
- `repo`: Repository name (string, required)
702659

703-
- **get_pull_request** - Get pull request details
704-
- `owner`: Repository owner (string, required)
705-
- `pullNumber`: Pull request number (number, required)
706-
- `repo`: Repository name (string, required)
707-
708660
- **get_pull_request_comments** - Get pull request comments
709661
- `owner`: Repository owner (string, required)
710662
- `pullNumber`: Pull request number (number, required)
@@ -732,24 +684,28 @@ The following sets of tools are available (all are on by default):
732684
- `pullNumber`: Pull request number (number, required)
733685
- `repo`: Repository name (string, required)
734686

735-
- **list_pull_requests** - List pull requests
736-
- `base`: Filter by base branch (string, optional)
737-
- `direction`: Sort direction (string, optional)
738-
- `head`: Filter by head user/org and branch (string, optional)
687+
- **manage_pull_request** - Manage Pull Request
688+
- `base`: The name of the branch you want the changes pulled into (required for 'create' operation) (string, optional)
689+
- `body`: Pull request body content (used for 'create', 'update' operations) (string, optional)
690+
- `commit_message`: Extra detail to append to merge commit message (used for 'merge' operation) (string, optional)
691+
- `commit_title`: Title for the merge commit (used for 'merge' operation) (string, optional)
692+
- `direction`: Sort direction for list operation: 'asc', 'desc' (string, optional)
693+
- `draft`: Whether to create as draft (used for 'create' operation) (boolean, optional)
694+
- `head`: The name of the branch where your changes are implemented (required for 'create' operation) (string, optional)
695+
- `list_base`: Filter by base branch for list operation (string, optional)
696+
- `list_head`: Filter by head user/org and branch for list operation (string, optional)
697+
- `list_state`: Filter by state for list operation: 'open', 'closed', 'all' (string, optional)
698+
- `maintainer_can_modify`: Whether maintainers can modify the pull request (used for 'create' operation) (boolean, optional)
699+
- `merge_method`: Merge method to use (used for 'merge' operation): 'merge', 'squash', 'rebase' (string, optional)
700+
- `operation`: Operation to perform: 'list', 'get', 'create', 'update', 'merge' (string, required)
739701
- `owner`: Repository owner (string, required)
740702
- `page`: Page number for pagination (min 1) (number, optional)
741703
- `perPage`: Results per page for pagination (min 1, max 100) (number, optional)
704+
- `pullNumber`: Pull request number (required for 'get', 'update', 'merge' operations) (number, optional)
742705
- `repo`: Repository name (string, required)
743-
- `sort`: Sort by (string, optional)
744-
- `state`: Filter by state (string, optional)
745-
746-
- **merge_pull_request** - Merge pull request
747-
- `commit_message`: Extra detail for merge commit (string, optional)
748-
- `commit_title`: Title for merge commit (string, optional)
749-
- `merge_method`: Merge method (string, optional)
750-
- `owner`: Repository owner (string, required)
751-
- `pullNumber`: Pull request number (number, required)
752-
- `repo`: Repository name (string, required)
706+
- `sort`: Sort by for list operation: 'created', 'updated', 'popularity', 'long-running' (string, optional)
707+
- `state`: State of the pull request (used for 'update' operation): 'open' or 'closed' (string, optional)
708+
- `title`: Pull request title (required for 'create' operation) (string, optional)
753709

754710
- **request_copilot_review** - Request Copilot review
755711
- `owner`: Repository owner (string, required)
@@ -772,18 +728,6 @@ The following sets of tools are available (all are on by default):
772728
- `pullNumber`: Pull request number (number, required)
773729
- `repo`: Repository name (string, required)
774730

775-
- **update_pull_request** - Edit pull request
776-
- `base`: New base branch name (string, optional)
777-
- `body`: New description (string, optional)
778-
- `draft`: Mark pull request as draft (true) or ready for review (false) (boolean, optional)
779-
- `maintainer_can_modify`: Allow maintainer edits (boolean, optional)
780-
- `owner`: Repository owner (string, required)
781-
- `pullNumber`: Pull request number to update (number, required)
782-
- `repo`: Repository name (string, required)
783-
- `reviewers`: GitHub usernames to request reviews from (string[], optional)
784-
- `state`: New state (string, optional)
785-
- `title`: New title (string, optional)
786-
787731
- **update_pull_request_branch** - Update pull request branch
788732
- `expectedHeadSha`: The expected SHA of the pull request's HEAD ref (string, optional)
789733
- `owner`: Repository owner (string, required)
@@ -811,38 +755,20 @@ The following sets of tools are available (all are on by default):
811755
- `repo`: Repository name (string, required)
812756
- `sha`: Required if updating an existing file. The blob SHA of the file being replaced. (string, optional)
813757

814-
- **create_repository** - Create repository
815-
- `autoInit`: Initialize with README (boolean, optional)
816-
- `description`: Repository description (string, optional)
817-
- `name`: Repository name (string, required)
818-
- `private`: Whether repo should be private (boolean, optional)
819-
820758
- **delete_file** - Delete file
821759
- `branch`: Branch to delete the file from (string, required)
822760
- `message`: Commit message (string, required)
823761
- `owner`: Repository owner (username or organization) (string, required)
824762
- `path`: Path to the file to delete (string, required)
825763
- `repo`: Repository name (string, required)
826764

827-
- **fork_repository** - Fork repository
828-
- `organization`: Organization to fork to (string, optional)
829-
- `owner`: Repository owner (string, required)
830-
- `repo`: Repository name (string, required)
831-
832765
- **get_commit** - Get commit details
833766
- `owner`: Repository owner (string, required)
834767
- `page`: Page number for pagination (min 1) (number, optional)
835768
- `perPage`: Results per page for pagination (min 1, max 100) (number, optional)
836769
- `repo`: Repository name (string, required)
837770
- `sha`: Commit SHA, branch name, or tag name (string, required)
838771

839-
- **get_file_contents** - Get file or directory contents
840-
- `owner`: Repository owner (username or organization) (string, required)
841-
- `path`: Path to file/directory (directories must end with a slash '/') (string, optional)
842-
- `ref`: Accepts optional git refs such as `refs/tags/{tag}`, `refs/heads/{branch}` or `refs/pull/{pr_number}/head` (string, optional)
843-
- `repo`: Repository name (string, required)
844-
- `sha`: Accepts optional commit SHA. If specified, it will be used instead of ref (string, optional)
845-
846772
- **get_latest_release** - Get latest release
847773
- `owner`: Repository owner (string, required)
848774
- `repo`: Repository name (string, required)
@@ -883,6 +809,20 @@ The following sets of tools are available (all are on by default):
883809
- `perPage`: Results per page for pagination (min 1, max 100) (number, optional)
884810
- `repo`: Repository name (string, required)
885811

812+
- **manage_repository** - Manage Repository
813+
- `autoInit`: Initialize with README (used for 'create' operation) (boolean, optional)
814+
- `default_branch_only`: Fork only default branch (used for 'fork' operation) (string, optional)
815+
- `description`: Repository description (used for 'create' operation) (string, optional)
816+
- `name`: Repository name (required for 'create' operation) (string, optional)
817+
- `operation`: Operation to perform: 'create', 'fork', 'get_file_contents' (string, required)
818+
- `organization`: Organization to fork to (used for 'fork' operation) (string, optional)
819+
- `owner`: Repository owner (required for 'fork', 'get_file_contents' operations) (string, optional)
820+
- `path`: Path to file/directory (required for 'get_file_contents' operation) (string, optional)
821+
- `private`: Whether repo should be private (used for 'create' operation) (boolean, optional)
822+
- `ref`: Git reference such as branch, tag, or commit SHA (used for 'get_file_contents' operation) (string, optional)
823+
- `repo`: Repository name (required for 'fork', 'get_file_contents' operations) (string, optional)
824+
- `sha`: Commit SHA (used for 'get_file_contents' operation) (string, optional)
825+
886826
- **push_files** - Push files to repository
887827
- `branch`: Branch to push to (string, required)
888828
- `files`: Array of file objects to push, each object with path (string) and content (string) (object[], required)
@@ -908,17 +848,14 @@ The following sets of tools are available (all are on by default):
908848

909849
<summary>Secret Protection</summary>
910850

911-
- **get_secret_scanning_alert** - Get secret scanning alert
912-
- `alertNumber`: The number of the alert. (number, required)
913-
- `owner`: The owner of the repository. (string, required)
914-
- `repo`: The name of the repository. (string, required)
915-
916-
- **list_secret_scanning_alerts** - List secret scanning alerts
917-
- `owner`: The owner of the repository. (string, required)
918-
- `repo`: The name of the repository. (string, required)
919-
- `resolution`: Filter by resolution (string, optional)
920-
- `secret_type`: A comma-separated list of secret types to return. All default secret patterns are returned. To return generic patterns, pass the token name(s) in the parameter. (string, optional)
921-
- `state`: Filter by state (string, optional)
851+
- **manage_secret_scanning_alerts** - Manage Secret Scanning Alerts
852+
- `alertNumber`: The number of the alert (required for 'get' operation) (number, optional)
853+
- `operation`: Operation to perform: 'list', 'get' (string, required)
854+
- `owner`: The owner of the repository (string, required)
855+
- `repo`: The name of the repository (string, required)
856+
- `resolution`: Filter by resolution (used for 'list' operation) (string, optional)
857+
- `secret_type`: A comma-separated list of secret types to return (used for 'list' operation) (string, optional)
858+
- `state`: Filter by state (used for 'list' operation) (string, optional)
922859

923860
</details>
924861

0 commit comments

Comments
 (0)