8000 collapse docs from readme · github/github-mcp-server@5c34ee8 · GitHub
[go: up one dir, main page]
Skip to content

Commit 5c34ee8

Browse files
tonytrgtonytrg
committed
collapse docs from readme
1 parent f51096d commit 5c34ee8

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>User</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

@@ -667,7 +676,11 @@ export GITHUB_MCP_TOOL_ADD_ISSUE_COMMENT_DESCRIPTION="an alternative description
667676
- `pullNumber`: Pull request number (number, required)
668677
- _Note_: Currently, this tool will only work for github.com
669678

670-
### Repositories
679+
</details>
680+
681+
<details>
682+
683+
<summary>Repositories</summary>
671684

672685
- **create_or_update_file** - Create or update a single file in a repository
673686
- `owner`: Repository owner (string, required)
@@ -761,7 +774,11 @@ export GITHUB_MCP_TOOL_ADD_ISSUE_COMMENT_DESCRIPTION="an alternative description
761774
- `page`: Page number (number, optional)
762775
- `perPage`: Results per page (number, optional)
763776

764-
### Users
777+
</details>
778+
779+
<details>
780+
781+
<summary>User</summary>
765782

766783
- **search_users** - Search for GitHub users
767784
- `q`: Search query (string, required)
@@ -770,7 +787,11 @@ export GITHUB_MCP_TOOL_ADD_ISSUE_COMMENT_DESCRIPTION="an alternative description
770787
- `page`: Page number (number, optional)
771788
- `perPage`: Results per page (number, optional)
772789

773-
### Actions
790+
</details>
791+
792+
<details>
793+
794+
<summary>Actions</summary>
774795

775796
- **list_workflows** - List workflows in a repository
776797

@@ -874,7 +895,11 @@ export GITHUB_MCP_TOOL_ADD_ISSUE_COMMENT_DESCRIPTION="an alternative description
874895
- `repo`: Repository name (string, required)
875896
- `run_id`: Workflow run ID (number, required)
876897

877-
### Code Scanning
898+
</details>
899+
900+
<details>
901+
902+
<summary>Code Scanning</summary>
878903

879904
- **get_code_scanning_alert** - Get a code scanning alert
880905

@@ -890,7 +915,11 @@ export GITHUB_MCP_TOOL_ADD_ISSUE_COMMENT_DESCRIPTION="an alternative description
890915
- `severity`: Alert severity (string, optional)
891916
- `tool_name`: The name of the tool used for code scanning (string, optional)
892917

893-
### Secret Scanning
918+
</details>
919+
920+
<details>
921+
922+
<summary>Secret Scanning</summary>
894923

895924
- **get_secret_scanning_alert** - Get a secret scanning alert
896925

@@ -905,7 +934,11 @@ export GITHUB_MCP_TOOL_ADD_ISSUE_COMMENT_DESCRIPTION="an alternative description
905934
- `secret_type`: The secret types to be filtered for in a comma-separated list (string, optional)
906935
- `resolution`: The resolution status (string, optional)
907936

908-
### Notifications
937+
</details>
938+
939+
<details>
940+
941+
<summary>Notifications</summary>
909942

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

973+
</details>
974+
940975
## Resources
941976

942-
### Repository Content
977+
<details>
978+
979+
<summary>Repository Content</summary>
943980

944981
- **Get Repository Content**
945982
Retrieves the content of a repository at a specific path.
@@ -990,6 +1027,8 @@ export GITHUB_MCP_TOOL_ADD_ISSUE_COMMENT_DESCRIPTION="an alternative description
9901027
- `prNumber`: Pull request number (string, required)
9911028
- `path`: File or directory path (string, optional)
9921029

1030+
</details>
1031+
9931032
## Library Usage
9941033

9951034
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)
0