Skip to content

Commit 798e674

Browse files
authored
collapse docs from readme (#580)
* collapse docs from readme * fix titles
1 parent 45d0270 commit 798e674

File tree

1 file changed

+49
-10
lines changed

1 file changed

+49
-10
lines changed

README.md

Lines changed: 49 additions & 10 deletions
Original file line numberDiff line numberDiff line change
@@ -426,12 +426,18 @@ export GITHUB_MCP_TOOL_ADD_ISSUE_COMMENT_DESCRIPTION="an alternative description
426426

427427
## Tools
428428

429-
### Users
429+
<details>
430+
431+
<summary>Context</summary>
430432

431433
- **get_me** - Get details of the authenticated user
432434
- No parameters required
433435

434-
### Issues
436+
</details>
437+
438+
<details>
439+
440+
<summary>Issues</summary>
435441

436442
- **get_issue** - Gets the contents of an issue within a repository
437443

@@ -499,8 +505,11 @@ export GITHUB_MCP_TOOL_ADD_ISSUE_COMMENT_DESCRIPTION="an alternative description
499505
- `issueNumber`: Issue number (number, required)
500506
- _Note_: This tool can help with creating a Pull Request with source code changes to resolve the issue. More information can be found at [GitHub Copilot documentation](https://docs.github.com/en/copilot/using-github-copilot/using-copilot-coding-agent-to-work-on-tasks/about-assigning-tasks-to-copilot)
501507

508+
</details>
502509

503-
### Pull Requests
510+
<details>
511+
512+
<summary>Pull Requests</summary>
504513

505514
- **get_pull_request** - Get details of a specific pull request
506515

@@ -640,7 +649,11 @@ export GITHUB_MCP_TOOL_ADD_ISSUE_COMMENT_DESCRIPTION="an alternative description
640649
- `pullNumber`: Pull request number (number, required)
641650
- _Note_: Currently, this tool will only work for github.com
642651

643-
### Repositories
652+
</details>
653+
654+
<details>
655+
656+
<summary>Repositories</summary>
644657

645658
- **create_or_update_file** - Create or update a single file in a repository
646659
- `owner`: Repository owner (string, required)
@@ -735,7 +748,11 @@ export GITHUB_MCP_TOOL_ADD_ISSUE_COMMENT_DESCRIPTION="an alternative description
735748
- `page`: Page number (number, optional)
736749
- `perPage`: Results per page (number, optional)
737750

738-
### Users
751+
</details>
752+
753+
<details>
754+
755+
<summary>Users</summary>
739756

740757
- **search_users** - Search for GitHub users
741758
- `q`: Search query (string, required)
@@ -744,7 +761,11 @@ export GITHUB_MCP_TOOL_ADD_ISSUE_COMMENT_DESCRIPTION="an alternative description
744761
- `page`: Page number (number, optional)
745762
- `perPage`: Results per page (number, optional)
746763

747-
### Actions
764+
</details>
765+
766+
<details>
767+
768+
<summary>Actions</summary>
748769

749770
- **list_workflows** - List workflows in a repository
750771

@@ -848,7 +869,11 @@ export GITHUB_MCP_TOOL_ADD_ISSUE_COMMENT_DESCRIPTION="an alternative description
848869
- `repo`: Repository name (string, required)
849870
- `run_id`: Workflow run ID (number, required)
850871

851-
### Code Scanning
872+
</details>
873+
874+
<details>
875+
876+
<summary>Code Scanning</summary>
852877

853878
- **get_code_scanning_alert** - Get a code scanning alert
854879

@@ -864,7 +889,11 @@ export GITHUB_MCP_TOOL_ADD_ISSUE_COMMENT_DESCRIPTION="an alternative description
864889
- `severity`: Alert severity (string, optional)
865890
- `tool_name`: The name of the tool used for code scanning (string, optional)
866891

867-
### Secret Scanning
892+
</details>
893+
894+
<details>
895+
896+
<summary>Secret Scanning</summary>
868897

869898
- **get_secret_scanning_alert** - Get a secret scanning alert
870899

@@ -879,7 +908,11 @@ export GITHUB_MCP_TOOL_ADD_ISSUE_COMMENT_DESCRIPTION="an alternative description
879908
- `secret_type`: The secret types to be filtered for in a comma-separated list (string, optional)
880909
- `resolution`: The resolution status (string, optional)
881910

882-
### Notifications
911+
</details>
912+
913+
<details>
914+
915+
<summary>Notifications</summary>
883916

884917
- **list_notifications** – List notifications for a GitHub user
885918
- `filter`: Filter to apply to the response (`default`, `include_read_notifications`, `only_participating`)
@@ -911,9 +944,13 @@ export GITHUB_MCP_TOOL_ADD_ISSUE_COMMENT_DESCRIPTION="an alternative description
911944
- `repo`: The name of the repository (string, required)
912945
- `action`: Action to perform: `ignore`, `watch`, or `delete` (string, required)
913946

947+
</details>
948+
914949
## Resources
915950

916-
### Repository Content
951+
<details>
952+
953+
<summary>Repository Content</summary>
917954

918955
- **Get Repository Content**
919956
Retrieves the content of a repository at a specific path.
@@ -964,6 +1001,8 @@ export GITHUB_MCP_TOOL_ADD_ISSUE_COMMENT_DESCRIPTION="an alternative description
9641001
- `prNumber`: Pull request number (string, required)
9651002
- `path`: File or directory path (string, optional)
9661003

1004+
</details>
1005+
9671006
## Library Usage
9681007

9691008
The exported Go API of this module should currently be considered unstable, and subject to breaking changes. In the future, we may offer stability; please file an issue if there is a use case where this would be valuable.

0 commit comments

Comments
 (0)