Skip to content

Commit 6de3210

Browse files
committed
Add documentation
1 parent e110366 commit 6de3210

File tree

1 file changed

+10
-11
lines changed

1 file changed

+10
-11
lines changed

README.md

Lines changed: 10 additions & 11 deletions
Original file line numberDiff line numberDiff line change
@@ -149,7 +149,7 @@ The following sets of tools are available (all are on by default):
149149
| ----------------------- | ------------------------------------------------------------- |
150150
| `repos` | Repository-related tools (file operations, branches, commits) |
151151
| `issues` | Issue-related tools (create, read, update, comment) |
152-
| `discussions` | GitHub Discussions tools (list, get, comments) |
152+
| `discussions` | GitHub Discussions tools (list, get, comments, categories) |
153153
| `users` | Anything relating to GitHub Users |
154154
| `pull_requests` | Pull request operations (create, merge, review) |
155155
| `code_security` | Code scanning alerts and security features |
@@ -582,7 +582,6 @@ export GITHUB_MCP_TOOL_ADD_ISSUE_COMMENT_DESCRIPTION="an alternative description
582582
- `secret_type`: The secret types to be filtered for in a comma-separated list (string, optional)
583583
- `resolution`: The resolution status (string, optional)
584584

585-
<<<<<<< HEAD
586585
### Notifications
587586

588587
- **list_notifications** – List notifications for a GitHub user
@@ -616,21 +615,17 @@ export GITHUB_MCP_TOOL_ADD_ISSUE_COMMENT_DESCRIPTION="an alternative description
616615
- `repo`: The name of the repository (string, required)
617616
- `action`: Action to perform: `ignore`, `watch`, or `delete` (string, required)
618617

619-
=======
620-
>>>>>>> 8d6b84c (doc: add support for GitHub discussions, with an example.)
621618
### Discussions
622619

623-
> [!NOTE]
624-
> As there is no support for discussions in the native GitHub go library, this toolset is deliberately limited to a few basic functions. The plan is to first implement native support in the GitHub go library, then use it for a better and consistent support in the MCP server.
625-
626620
- **list_discussions** - List discussions for a repository
627621
- `owner`: Repository owner (string, required)
628622
- `repo`: Repository name (string, required)
629-
- `state`: State filter (open, closed, all) (string, optional)
630-
- `labels`: Filter by label names (string[], optional)
623+
- `categoryId`: Filter by category ID (string, optional)
631624
- `since`: Filter by date (ISO 8601 timestamp) (string, optional)
632-
- `page`: Page number (number, optional)
633-
- `perPage`: Results per page (number, optional)
625+
- `first`: Pagination - Number of records to retrieve (number, optional)
626+
- `after`: Pagination - Cursor to start with (string, optional)
627+
- `sort`: Sort by ('CREATED_AT', 'UPDATED_AT') (string, optional)
628+
- `direction`: Sort direction ('ASC', 'DESC') (string, optional)
634629

635630
- **get_discussion** - Get a specific discussion by ID
636631
- `owner`: Repository owner (string, required)
@@ -642,6 +637,10 @@ export GITHUB_MCP_TOOL_ADD_ISSUE_COMMENT_DESCRIPTION="an alternative description
642637
- `repo`: Repository name (string, required)
643638
- `discussion_id`: Discussion ID (number, required)
644639

640+
- **list_discussion_categories** - List discussion categories for a repository, with their IDs and names
641+
- `owner`: Repository owner (string, required)
642+
- `repo`: Repository name (string, required)
643+
645644
## Resources
646645

647646
### Repository Content

0 commit comments

Comments
 (0)