Skip to content

Commit 15cb577

Browse files
committed
Update docs
1 parent 1dd2552 commit 15cb577

File tree

2 files changed

+40
-66
lines changed

2 files changed

+40
-66
lines changed

README.md

Lines changed: 39 additions & 66 deletions
Original file line numberDiff line numberDiff line change
@@ -269,7 +269,7 @@ The following sets of tools are available (all are on by default):
269269
| `context` | **Strongly recommended**: Tools that provide context about the current user and GitHub context you are operating in |
270270
| `actions` | GitHub Actions workflows and CI/CD operations |
271271
| `code_security` | Code security related tools, such as GitHub Code Scanning |
272-
| `discussions` | GitHub Discussions tools (list, get, comments, categories) |
272+
| `discussions` | GitHub Discussions related tools |
273273
| `experiments` | Experimental features that are not considered stable yet |
274274
| `issues` | GitHub Issues related tools |
275275
| `notifications` | GitHub Notifications related tools |
@@ -555,6 +555,43 @@ export GITHUB_MCP_TOOL_ADD_ISSUE_COMMENT_DESCRIPTION="an alternative description
555555

556556
<details>
557557

558+
<summary>Discussions</summary>
559+
560+
- **get_discussion** - Get discussion
561+
- `discussionNumber`: Discussion Number (number, required)
562+
- `owner`: Repository owner (string, required)
563+
- `repo`: Repository name (string, required)
564+
565+
- **get_discussion_comments** - Get discussion comments
566+
- `discussionNumber`: Discussion Number (number, required)
567+
- `owner`: Repository owner (string, required)
568+
- `repo`: Repository name (string, required)
569+
570+
- **list_discussion_categories** - List discussion categories
571+
- `after`: Cursor for pagination, use the 'after' field from the previous response (string, optional)
572+
- `before`: Cursor for pagination, use the 'before' field from the previous response (string, optional)
573+
- `first`: Number of categories to return per page (min 1, max 100) (number, optional)
574+
- `last`: Number of categories to return from the end (min 1, max 100) (number, optional)
575+
- `owner`: Repository owner (string, required)
576+
- `repo`: Repository name (string, required)
577+
578+
- **list_discussions** - List discussions
579+
- `after`: Cursor for pagination, use the 'after' field from the previous response (string, optional)
580+
- `answered`: Filter by whether discussions have been answered or not (boolean, optional)
581+
- `before`: Cursor for pagination, use the 'before' field from the previous response (string, optional)
582+
- `category`: Category filter (name) (string, optional)
583+
- `direction`: Sort direction (string, optional)
584+
- `first`: Number of discussions to return per page (min 1, max 100) (number, optional)
585+
- `last`: Number of discussions to return from the end (min 1, max 100) (number, optional)
586+
- `owner`: Repository owner (string, required)
587+
- `repo`: Repository name (string, required)
588+
- `since`: Filter by date (ISO 8601 timestamp) (string, optional)
589+
- `sort`: Sort field (string, optional)
590+
591+
</details>
592+
593+
<details>
594+
558595
<summary>Issues</summary>
559596

560597
- **add_issue_comment** - Add comment to issue
@@ -921,71 +958,7 @@ export GITHUB_MCP_TOOL_ADD_ISSUE_COMMENT_DESCRIPTION="an alternative description
921958

922959
</details>
923960

924-
- **manage_repository_notification_subscription** – Manage a repository notification subscription (ignore, watch, or delete)
925-
- `owner`: The account owner of the repository (string, required)
926-
- `repo`: The name of the repository (string, required)
927-
- `action`: Action to perform: `ignore`, `watch`, or `delete` (string, required)
928-
929-
### Discussions
930-
931-
- **list_discussions** - List discussions for a repository
932-
- `owner`: Repository owner (string, required)
933-
- `repo`: Repository name (string, required)
934-
- `category`: Filter by category name (string, optional)
935-
- `since`: Filter by date (ISO 8601 timestamp) (string, optional)
936-
- `first`: Pagination - Number of records to retrieve (number, optional)
937-
- `last`: Pagination - Number of records to retrieve from the end (number, optional)
938-
- `after`: Pagination - Cursor to start with (string, optional)
939-
- `before`: Pagination - Cursor to end with (string, optional)
940-
- `sort`: Sort by ('CREATED_AT', 'UPDATED_AT') (string, optional)
941-
- `direction`: Sort direction ('ASC', 'DESC') (string, optional)
942-
- `answered`: Filter by whether discussions have been answered or not (boolean, optional)
943-
944-
- **get_discussion** - Get a specific discussion by ID
945-
- `owner`: Repository owner (string, required)
946-
- `repo`: Repository name (string, required)
947-
- `discussionNumber`: Discussion number (required)
948-
949-
- **get_discussion_comments** - Get comments from a discussion
950-
- `owner`: Repository owner (string, required)
951-
- `repo`: Repository name (string, required)
952-
- `discussionNumber`: Discussion number (required)
953-
954-
- **list_discussion_categories** - List discussion categories for a repository, with their IDs and names
955-
- `owner`: Repository owner (string, required)
956-
- `repo`: Repository name (string, required)
957-
- `first`: Pagination - Number of categories to return per page (number, optional, min 1, max 100)
958-
- `last`: Pagination - Number of categories to return from the end (number, optional, min 1, max 100)
959-
- `after`: Pagination - Cursor to start with (string, optional)
960-
- `before`: Pagination - Cursor to end with (string, optional)
961-
962-
## Resources
963-
964-
### Repository Content
965-
966-
- **Get Repository Content**
967-
Retrieves the content of a repository at a specific path.
968-
969-
- **Template**: `repo://{owner}/{repo}/contents{/path*}`
970-
- **Parameters**:
971-
- `owner`: Repository owner (string, required)
972-
- `repo`: Repository name (string, required)
973-
- `path`: File or directory path (string, optional)
974-
975-
- **Get Repository Content for a Specific Branch**
976-
Retrieves the content of a repository at a specific path for a given branch.
977-
978-
- **Template**: `repo://{owner}/{repo}/refs/heads/{branch}/contents{/path*}`
979-
- **Parameters**:
980-
- `owner`: Repository owner (string, required)
981-
- `repo`: Repository name (string, required)
982-
- `branch`: Branch name (string, required)
983-
- `path`: File or directory path (string, optional)
984-
985-
- **Get Repository Content for a Specific Commit**
986-
Retrieves the content of a repository at a specific path for a given commit.
987-
988-
961+
<details>
989962

990963
<summary>Users</summary>
991964

docs/remote-server.md

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -20,6 +20,7 @@ Below is a table of available toolsets for the remote GitHub MCP Server. Each to
2020
| all | All available GitHub MCP tools | https://api.githubcopilot.com/mcp/ | [Install](https://insiders.vscode.dev/redirect/mcp/install?name=github&config=%7B%22type%22%3A%20%22http%22%2C%22url%22%3A%20%22https%3A%2F%2Fapi.githubcopilot.com%2Fmcp%2F%22%7D) | [read-only](https://api.githubcopilot.com/mcp/readonly) | [Install read-only](https://insiders.vscode.dev/redirect/mcp/install?name=github&config=%7B%22type%22%3A%20%22http%22%2C%22url%22%3A%20%22https%3A%2F%2Fapi.githubcopilot.com%2Fmcp%2Freadonly%22%7D) |
2121
| Actions | GitHub Actions workflows and CI/CD operations | https://api.githubcopilot.com/mcp/x/actions | [Install](https://insiders.vscode.dev/redirect/mcp/install?name=gh-actions&config=%7B%22type%22%3A%20%22http%22%2C%22url%22%3A%20%22https%3A%2F%2Fapi.githubcopilot.com%2Fmcp%2Fx%2Factions%22%7D) | [read-only](https://api.githubcopilot.com/mcp/x/actions/readonly) | [Install read-only](https://insiders.vscode.dev/redirect/mcp/install?name=gh-actions&config=%7B%22type%22%3A%20%22http%22%2C%22url%22%3A%20%22https%3A%2F%2Fapi.githubcopilot.com%2Fmcp%2Fx%2Factions%2Freadonly%22%7D) |
2222
| Code Security | Code security related tools, such as GitHub Code Scanning | https://api.githubcopilot.com/mcp/x/code_security | [Install](https://insiders.vscode.dev/redirect/mcp/install?name=gh-code_security&config=%7B%22type%22%3A%20%22http%22%2C%22url%22%3A%20%22https%3A%2F%2Fapi.githubcopilot.com%2Fmcp%2Fx%2Fcode_security%22%7D) | [read-only](https://api.githubcopilot.com/mcp/x/code_security/readonly) | [Install read-only](https://insiders.vscode.dev/redirect/mcp/install?name=gh-code_security&config=%7B%22type%22%3A%20%22http%22%2C%22url%22%3A%20%22https%3A%2F%2Fapi.githubcopilot.com%2Fmcp%2Fx%2Fcode_security%2Freadonly%22%7D) |
23+
| Discussions | GitHub Discussions related tools | https://api.githubcopilot.com/mcp/x/discussions | [Install](https://insiders.vscode.dev/redirect/mcp/install?name=gh-discussions&config=%7B%22type%22%3A%20%22http%22%2C%22url%22%3A%20%22https%3A%2F%2Fapi.githubcopilot.com%2Fmcp%2Fx%2Fdiscussions%22%7D) | [read-only](https://api.githubcopilot.com/mcp/x/discussions/readonly) | [Install read-only](https://insiders.vscode.dev/redirect/mcp/install?name=gh-discussions&config=%7B%22type%22%3A%20%22http%22%2C%22url%22%3A%20%22https%3A%2F%2Fapi.githubcopilot.com%2Fmcp%2Fx%2Fdiscussions%2Freadonly%22%7D) |
2324
| Experiments | Experimental features that are not considered stable yet | https://api.githubcopilot.com/mcp/x/experiments | [Install](https://insiders.vscode.dev/redirect/mcp/install?name=gh-experiments&config=%7B%22type%22%3A%20%22http%22%2C%22url%22%3A%20%22https%3A%2F%2Fapi.githubcopilot.com%2Fmcp%2Fx%2Fexperiments%22%7D) | [read-only](https://api.githubcopilot.com/mcp/x/experiments/readonly) | [Install read-only](https://insiders.vscode.dev/redirect/mcp/install?name=gh-experiments&config=%7B%22type%22%3A%20%22http%22%2C%22url%22%3A%20%22https%3A%2F%2Fapi.githubcopilot.com%2Fmcp%2Fx%2Fexperiments%2Freadonly%22%7D) |
2425
| Issues | GitHub Issues related tools | https://api.githubcopilot.com/mcp/x/issues | [Install](https://insiders.vscode.dev/redirect/mcp/install?name=gh-issues&config=%7B%22type%22%3A%20%22http%22%2C%22url%22%3A%20%22https%3A%2F%2Fapi.githubcopilot.com%2Fmcp%2Fx%2Fissues%22%7D) | [read-only](https://api.githubcopilot.com/mcp/x/issues/readonly) | [Install read-only](https://insiders.vscode.dev/redirect/mcp/install?name=gh-issues&config=%7B%22type%22%3A%20%22http%22%2C%22url%22%3A%20%22https%3A%2F%2Fapi.githubcopilot.com%2Fmcp%2Fx%2Fissues%2Freadonly%22%7D) |
2526
| Notifications | GitHub Notifications related tools | https://api.githubcopilot.com/mcp/x/notifications | [Install](https://insiders.vscode.dev/redirect/mcp/install?name=gh-notifications&config=%7B%22type%22%3A%20%22http%22%2C%22url%22%3A%20%22https%3A%2F%2Fapi.githubcopilot.com%2Fmcp%2Fx%2Fnotifications%22%7D) | [read-only](https://api.githubcopilot.com/mcp/x/notifications/readonly) | [Install read-only](https://insiders.vscode.dev/redirect/mcp/install?name=gh-notifications&config=%7B%22type%22%3A%20%22http%22%2C%22url%22%3A%20%22https%3A%2F%2Fapi.githubcopilot.com%2Fmcp%2Fx%2Fnotifications%2Freadonly%22%7D) |

0 commit comments

Comments
 (0)