- Notifications
You must be signed in to change notification settings - Fork940
Combine tools#349
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 ourterms of service andprivacy statement. We’ll occasionally send you account related emails.
Already on GitHub?Sign in to your account
Closed
Uh oh!
There was an error while loading.Please reload this page.
Closed
Combine tools#349
Changes fromall commits
Commits
Show all changes
10 commits Select commitHold shift + click to select a range
bdb59e0 feat: add GitHub notifications tools for managing user notifications
sridharavinashb5b3211 Merge branch 'main' into notifications-tooling
sridharavinashdbdef79 refactor: update notification functions to use GetClientFn . Fix con…
sridharavinashf75c234 lint: simplify boolean check in OptionalBoolParamWithDefault function
sridharavinash6eaa8d3 Notifications Mark as done with number implementation (#270)
rfearinge396227 Merge branch 'main' into notifications-tooling
sridharavinashbc897a1 Fix merge conflicts
sridharavinashee6618e Combine tools
rfearing569711f Update tools.go
rfearinga5550e4 Update pkg/github/notifications.go
rfearingFile filter
Filter by extension
Conversations
Failed to load comments.
Loading
Uh oh!
There was an error while loading.Please reload this page.
Jump to
Jump to file
Failed to load files.
Loading
Uh oh!
There was an error while loading.Please reload this page.
Diff view
Diff view
There are no files selected for viewing
243 changes: 243 additions & 0 deletionspkg/github/notifications.go
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,243 @@ | ||
| package github | ||
| import ( | ||
| "context" | ||
| "encoding/json" | ||
| "fmt" | ||
| "io" | ||
| "net/http" | ||
| "strconv" | ||
| "time" | ||
| "github.com/github/github-mcp-server/pkg/translations" | ||
| "github.com/google/go-github/v69/github" | ||
| "github.com/mark3labs/mcp-go/mcp" | ||
| "github.com/mark3labs/mcp-go/server" | ||
| ) | ||
| // getNotifications creates a tool to list notifications for the current user. | ||
| func GetNotifications(getClient GetClientFn, t translations.TranslationHelperFunc) (tool mcp.Tool, handler server.ToolHandlerFunc) { | ||
| return mcp.NewTool("get_notifications", | ||
| mcp.WithDescription(t("TOOL_GET_NOTIFICATIONS_DESCRIPTION", "Get notifications for the authenticated GitHub user")), | ||
| mcp.WithBoolean("all", | ||
| mcp.Description("If true, show notifications marked as read. Default: false"), | ||
| ), | ||
| mcp.WithBoolean("participating", | ||
| mcp.Description("If true, only shows notifications in which the user is directly participating or mentioned. Default: false"), | ||
| ), | ||
| mcp.WithString("since", | ||
| mcp.Description("Only show notifications updated after the given time (ISO 8601 format)"), | ||
| ), | ||
| mcp.WithString("before", | ||
| mcp.Description("Only show notifications updated before the given time (ISO 8601 format)"), | ||
| ), | ||
| mcp.WithNumber("per_page", | ||
| mcp.Description("Results per page (max 100). Default: 30"), | ||
| ), | ||
| mcp.WithNumber("page", | ||
| mcp.Description("Page number of the results to fetch. Default: 1"), | ||
| ), | ||
| ), | ||
| func(ctx context.Context, request mcp.CallToolRequest) (*mcp.CallToolResult, error) { | ||
| client, err := getClient(ctx) | ||
| if err != nil { | ||
| return nil, fmt.Errorf("failed to get GitHub client: %w", err) | ||
| } | ||
| // Extract optional parameters with defaults | ||
| all, err := OptionalBoolParamWithDefault(request, "all", false) | ||
| if err != nil { | ||
| return mcp.NewToolResultError(err.Error()), nil | ||
| } | ||
| participating, err := OptionalBoolParamWithDefault(request, "participating", false) | ||
| if err != nil { | ||
| return mcp.NewToolResultError(err.Error()), nil | ||
| } | ||
| since, err := OptionalStringParamWithDefault(request, "since", "") | ||
| if err != nil { | ||
| return mcp.NewToolResultError(err.Error()), nil | ||
| } | ||
| before, err := OptionalStringParam(request, "before") | ||
| if err != nil { | ||
| return mcp.NewToolResultError(err.Error()), nil | ||
| } | ||
| perPage, err := OptionalIntParamWithDefault(request, "per_page", 30) | ||
| if err != nil { | ||
| return mcp.NewToolResultError(err.Error()), nil | ||
| } | ||
| page, err := OptionalIntParamWithDefault(request, "page", 1) | ||
| if err != nil { | ||
| return mcp.NewToolResultError(err.Error()), nil | ||
| } | ||
| // Build options | ||
| opts := &github.NotificationListOptions{ | ||
| All: all, | ||
| Participating: participating, | ||
| ListOptions: github.ListOptions{ | ||
| Page: page, | ||
| PerPage: perPage, | ||
| }, | ||
| } | ||
| // Parse time parameters if provided | ||
| if since != "" { | ||
| sinceTime, err := time.Parse(time.RFC3339, since) | ||
| if err != nil { | ||
| return mcp.NewToolResultError(fmt.Sprintf("invalid since time format, should be RFC3339/ISO8601: %v", err)), nil | ||
| } | ||
| opts.Since = sinceTime | ||
| } | ||
| if before != "" { | ||
| beforeTime, err := time.Parse(time.RFC3339, before) | ||
| if err != nil { | ||
| return mcp.NewToolResultError(fmt.Sprintf("invalid before time format, should be RFC3339/ISO8601: %v", err)), nil | ||
| } | ||
| opts.Before = beforeTime | ||
| } | ||
| // Call GitHub API | ||
| notifications, resp, err := client.Activity.ListNotifications(ctx, opts) | ||
| if err != nil { | ||
| return nil, fmt.Errorf("failed to get notifications: %w", err) | ||
| } | ||
| defer func() { _ = resp.Body.Close() }() | ||
| if resp.StatusCode != http.StatusOK { | ||
| body, err := io.ReadAll(resp.Body) | ||
| if err != nil { | ||
| return nil, fmt.Errorf("failed to read response body: %w", err) | ||
| } | ||
| return mcp.NewToolResultError(fmt.Sprintf("failed to get notifications: %s", string(body))), nil | ||
| } | ||
| // Marshal response to JSON | ||
| r, err := json.Marshal(notifications) | ||
| if err != nil { | ||
| return nil, fmt.Errorf("failed to marshal response: %w", err) | ||
| } | ||
| return mcp.NewToolResultText(string(r)), nil | ||
| } | ||
| } | ||
| // ManageNotifications creates a tool to manage notifications (mark as read, mark all as read, or mark as done). | ||
| func ManageNotifications(getClient GetClientFn, t translations.TranslationHelperFunc) (tool mcp.Tool, handler server.ToolHandlerFunc) { | ||
| return mcp.NewTool("manage_notifications", | ||
| mcp.WithDescription(t("TOOL_MANAGE_NOTIFICATIONS_DESCRIPTION", "Manage notifications (mark as read, mark all as read, or mark as done)")), | ||
| mcp.WithString("action", | ||
| mcp.Required(), | ||
| mcp.Description("The action to perform: 'mark_read', 'mark_all_read', or 'mark_done'"), | ||
| ), | ||
| mcp.WithString("threadID", | ||
| mcp.Description("The ID of the notification thread (required for 'mark_read' and 'mark_done')"), | ||
| ), | ||
| mcp.WithString("lastReadAt", | ||
| mcp.Description("Describes the last point that notifications were checked (optional, for 'mark_all_read'). Default: Now"), | ||
| ), | ||
| ), | ||
| func(ctx context.Context, request mcp.CallToolRequest) (*mcp.CallToolResult, error) { | ||
| client, err := getClient(ctx) | ||
| if err != nil { | ||
| return nil, fmt.Errorf("failed to get GitHub client: %w", err) | ||
| } | ||
| action, err := requiredParam[string](request, "action") | ||
| if err != nil { | ||
| return mcp.NewToolResultError(err.Error()), nil | ||
| } | ||
| switch action { | ||
| case "mark_read": | ||
There was a problem hiding this comment. Choose a reason for hiding this commentThe reason will be displayed to describe this comment to others.Learn more. The 'mark_read' action does not call any API to mark a notification as read; it directly returns a success message. Please add the appropriate API call to actually mark the notification as read. Copilot uses AI. Check for mistakes. | ||
| threadID, err := requiredParam[string](request, "threadID") | ||
| if err != nil { | ||
| return mcp.NewToolResultError(err.Error()), nil | ||
| } | ||
| resp, err := client.Activity.MarkThreadRead(ctx, threadID) | ||
| if err != nil { | ||
| return nil, fmt.Errorf("failed to mark notification as read: %w", err) | ||
| } | ||
| defer func() { _ = resp.Body.Close() }() | ||
| if resp.StatusCode != http.StatusResetContent && resp.StatusCode != http.StatusOK { | ||
| body, err := io.ReadAll(resp.Body) | ||
| if err != nil { | ||
| return nil, fmt.Errorf("failed to read response body: %w", err) | ||
| } | ||
| return mcp.NewToolResultError(fmt.Sprintf("failed to mark notification as read: %s", string(body))), nil | ||
| } | ||
| return mcp.NewToolResultText("Notification marked as read"), nil | ||
| case "mark_done": | ||
| threadIDStr, err := requiredParam[string](request, "threadID") | ||
| if err != nil { | ||
| return mcp.NewToolResultError(err.Error()), nil | ||
| } | ||
| threadID, err := strconv.ParseInt(threadIDStr, 10, 64) | ||
| if err != nil { | ||
| return mcp.NewToolResultError("Invalid threadID: must be a numeric value"), nil | ||
| } | ||
| resp, err := client.Activity.MarkThreadDone(ctx, threadID) | ||
| if err != nil { | ||
| return nil, fmt.Errorf("failed to mark notification as done: %w", err) | ||
| } | ||
| defer func() { _ = resp.Body.Close() }() | ||
| if resp.StatusCode != http.StatusResetContent && resp.StatusCode != http.StatusOK { | ||
| body, err := io.ReadAll(resp.Body) | ||
| if err != nil { | ||
| return nil, fmt.Errorf("failed to read response body: %w", err) | ||
| } | ||
| return mcp.NewToolResultError(fmt.Sprintf("failed to mark all notifications as read: %s", string(body))), nil | ||
| } | ||
| return mcp.NewToolResultText("Notification marked as done"), nil | ||
| case "mark_all_read": | ||
| lastReadAt, err := OptionalStringParam(request, "lastReadAt") | ||
| if err != nil { | ||
| return mcp.NewToolResultError(err.Error()), nil | ||
| } | ||
| var markReadOptions github.Timestamp | ||
| if lastReadAt != "" { | ||
| lastReadTime, err := time.Parse(time.RFC3339, lastReadAt) | ||
| if err != nil { | ||
| return mcp.NewToolResultError(fmt.Sprintf("invalid lastReadAt time format, should be RFC3339/ISO8601: %v", err)), nil | ||
| } | ||
| markReadOptions = github.Timestamp{ | ||
| Time: lastReadTime, | ||
| } | ||
| } | ||
| resp, err := client.Activity.MarkNotificationsRead(ctx, markReadOptions) | ||
| if err != nil { | ||
| return nil, fmt.Errorf("failed to mark all notifications as read: %w", err) | ||
| } | ||
| defer func() { _ = resp.Body.Close() }() | ||
| if resp.StatusCode != http.StatusResetContent && resp.StatusCode != http.StatusOK { | ||
| body, err := io.ReadAll(resp.Body) | ||
| if err != nil { | ||
| return nil, fmt.Errorf("failed to read response body: %w", err) | ||
| } | ||
| return mcp.NewToolResultError(fmt.Sprintf("failed to mark all notifications as read: %s", string(body))), nil | ||
| } | ||
| return mcp.NewToolResultText("All notifications marked as read"), nil | ||
| default: | ||
| return mcp.NewToolResultError("Invalid action: must be 'mark_read', 'mark_all_read', or 'mark_done'"), nil | ||
| } | ||
| } | ||
| } | ||
41 changes: 41 additions & 0 deletionspkg/github/server.go
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.Learn more about bidirectional Unicode characters
10 changes: 10 additions & 0 deletionspkg/github/tools.go
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.Learn more about bidirectional Unicode characters
Add this suggestion to a batch that can be applied as a single commit.This suggestion is invalid because no changes were made to the code.Suggestions cannot be applied while the pull request is closed.Suggestions cannot be applied while viewing a subset of changes.Only one suggestion per line can be applied in a batch.Add this suggestion to a batch that can be applied as a single commit.Applying suggestions on deleted lines is not supported.You must change the existing code in this line in order to create a valid suggestion.Outdated suggestions cannot be applied.This suggestion has been applied or marked resolved.Suggestions cannot be applied from pending reviews.Suggestions cannot be applied on multi-line comments.Suggestions cannot be applied while the pull request is queued to merge.Suggestion cannot be applied right now. Please check back later.