-
Notifications
You must be signed in to change notification settings - Fork 870
feat: add GitHub notifications tools for managing user notifications #225
New issue
Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.
By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.
Already on GitHub? Sign in to your account
base: main
Are you sure you want to change the base?
Conversation
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Pull Request Overview
This PR introduces new GitHub notifications management tooling to allow users to retrieve notifications, mark them as read (individually or in bulk), and fetch detailed thread information.
- Added notifications tools to the server initialization in pkg/github/server.go.
- Implemented functions in pkg/github/notifications.go for handling notification retrieval and state updates with appropriate error handling and time parsing.
Reviewed Changes
Copilot reviewed 2 out of 2 changed files in this pull request and generated no comments.
File | Description |
---|---|
pkg/github/server.go | Added notifications tools and helper functions for optional params. |
pkg/github/notifications.go | Implements API integrations for GitHub notifications management. |
Comments suppressed due to low confidence (2)
pkg/github/server.go:262
- The condition unconditionally returns the default value when v is false, which means an explicit false value from the user is ignored. Consider checking for the presence of the parameter instead of evaluating its boolean value directly.
if !v { return d, nil }
pkg/github/notifications.go:130
- [nitpick] The parameter name 'getclient' is inconsistent with other functions that use 'getClient'. Consider renaming it to 'getClient' for consistency.
func MarkNotificationRead(getclient GetClientFn, t translations.TranslationHelperFunc) (tool mcp.Tool, handler server.ToolHandlerFunc) {
36cd64f
to
f998fc7
Compare
4624a97
to
d49b7a6
Compare
9878a8a
to
ea51752
Compare
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Pull Request Overview
This PR introduces a new “notifications” toolset for managing GitHub notifications, including unit and end-to-end tests, plus documentation for opting into state-mutating tests.
- Registers the
notifications
toolset inpkg/github/tools.go
- Adds unit tests for each notification tool (
pkg/github/notifications_test.go
) - Implements e2e tests and a README section to skip global-state mutations (
e2e/e2e_test.go
,e2e/README.md
)
Reviewed Changes
Copilot reviewed 5 out of 5 changed files in this pull request and generated 1 comment.
File | Description |
---|---|
pkg/github/tools.go | Register new “notifications” toolset |
pkg/github/notifications_test.go | Add unit tests for list, get, dismiss, mark-all, and subscription tools |
e2e/e2e_test.go | Add e2e tests for notification tools and skip logic |
e2e/README.md | Document environment flag to skip mutation tests |
Comments suppressed due to low confidence (5)
pkg/github/notifications_test.go:57
- Consider adding a unit test for the "watch" action in
ManageNotificationSubscription
, since currently only "ignore" and "delete" are covered.
func Test_ManageNotificationSubscription(t *testing.T) {
pkg/github/notifications_test.go:114
- The "watch" action isn’t tested in
Test_ManageRepositoryNotificationSubscription
; consider adding it to ensure full coverage of subscription states.
func Test_ManageRepositoryNotificationSubscription(t *testing.T) {
pkg/github/notifications_test.go:180
- Add a success-case test for the "done" state in
Test_DismissNotification
to cover both supported states.
// Success case: mark as read
pkg/github/notifications_test.go:224
- Include a unit test for passing the
since
timestamp intoMarkAllNotificationsRead
to validate the optional filter parameter.
request := createMCPRequest(map[string]interface{}{})
e2e/e2e_test.go:1552
- Requiring exactly one notification is brittle—
list_notifications
can return multiple items. Consider usingrequire.NotEmpty
or asserting a minimum length.
require.Len(t, resp.Content, 1, "expected content to have one item")
toolsets.NewServerTool(GetNotificationDetails(getClient, t)), | ||
). | ||
AddWriteTools( | ||
toolsets.NewServerTool(DismissNotification(getClient, t)), |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
[nitpick] The name DismissNotification
may be unclear since it handles multiple states (read/done). Consider renaming to MarkNotificationState
or similar for better API clarity.
toolsets.NewServerTool(DismissNotification(getClient, t)), | |
toolsets.NewServerTool(MarkNotificationState(getClient, t)), |
Copilot uses AI. Check for mistakes.
GitHub Notifications Tooling
This PR adds support for managing GitHub notifications
Features Added
New Tools
get_notifications
: Retrieve a list of notifications for the authenticated GitHub user with filtering options for read/unread status, participation, and time rangesmark_notification_read
: Mark a specific notification thread as readmark_notification_done
: Mark a specific notification thread as donemark_all_notifications_read
: Mark all notifications as read with an optional timestampget_notification_thread
: Fetch details of a specific notification threadTechnical Implementation