manage-repo-subscription
Control GitHub repository notification settings to customize which activities trigger alerts, including watching all, participating only, or muting notifications.
Instructions
Manage repository subscription settings including fine-grained notification preferences
Input Schema
TableJSON Schema
| Name | Required | Description | Default |
|---|---|---|---|
| owner | Yes | The account owner of the repository. The name is not case sensitive. | |
| repo | Yes | The name of the repository without the .git extension. The name is not case sensitive. | |
| action | Yes | The action to perform: all_activity (watch all), default (participating and @mentions only), ignore (mute notifications), or get (view current settings) | |
| options | No | Optional settings for custom subscription configuration |
Implementation Reference
- The main handler function that executes the tool logic. It processes the input parameters and performs GitHub API calls based on the 'action' (get, all_activity, default, ignore).export async function manageRepoSubscriptionHandler(args: ManageRepoSubscriptionArgs) { const { owner, repo, action, options } = args; try { switch (action) { case 'get': try { const response = await githubGet<SubscriptionResponse>(`/repos/${owner}/${repo}/subscription`); const formattedDate = new Date(response.created_at).toLocaleString(); return { content: [{ type: 'text', text: `Subscription status for ${owner}/${repo}: • API Subscription: ${response.subscribed ? 'Watching all activity' : 'Not watching'} • Notifications: ${response.ignored ? 'Ignored' : 'Active'} • Created at: ${formattedDate} • Web Interface: https://github.com/${owner}/${repo}` }] }; } catch (error: any) { // Special handling for 404 in get action - could be default or custom settings if (error.message?.includes('Resource not found')) { return { content: [{ type: 'text', text: `Subscription status for ${owner}/${repo}: • Default settings (participating and @mentions only) • or Custom through the GitHub web interface at: https://github.com/${owner}/${repo}` }] }; } throw error; // Re-throw other errors to be handled by the outer catch } case 'all_activity': await githubPut(`/repos/${owner}/${repo}/subscription`, { subscribed: true, ignored: false }); return { content: [{ type: 'text', text: `Successfully set ${owner}/${repo} to watch all activity` }] }; case 'default': await githubDelete(`/repos/${owner}/${repo}/subscription`); return { content: [{ type: 'text', text: `Successfully set ${owner}/${repo} to default settings (participating and @mentions only)` }] }; case 'ignore': await githubPut(`/repos/${owner}/${repo}/subscription`, { subscribed: false, ignored: true }); return { content: [{ type: 'text', text: `Successfully set ${owner}/${repo} to ignore all notifications` }] }; } } catch (error: any) { return { isError: true, content: [{ type: 'text', text: formatError(`Failed to manage repository subscription for ${owner}/${repo}`, error) }] }; } }
- Zod schema defining the input parameters for the manage-repo-subscription tool, including owner, repo, action, and optional options.export const manageRepoSubscriptionSchema = z.object({ owner: z.string().min(1, 'Repository owner is required') .describe('The account owner of the repository. The name is not case sensitive.'), repo: z.string().min(1, 'Repository name is required') .describe('The name of the repository without the .git extension. The name is not case sensitive.'), action: z.enum(['all_activity', 'default', 'ignore', 'get']) .describe('The action to perform: all_activity (watch all), default (participating and @mentions only), ignore (mute notifications), or get (view current settings)'), options: z.object({ subscribed: z.boolean().optional() .describe('Whether to receive notifications from this repository'), ignored: z.boolean().optional() .describe('Whether to ignore all notifications from this repository') }).optional() .describe('Optional settings for custom subscription configuration') });
- src/tools/manage-repo-subscription.ts:120-127 (registration)Registers the manage-repo-subscription tool with the MCP server, specifying name, description, schema, and handler.export function registerManageRepoSubscriptionTool(server: any) { server.tool( 'manage-repo-subscription', 'Manage repository subscription settings including fine-grained notification preferences', manageRepoSubscriptionSchema.shape, manageRepoSubscriptionHandler ); }
- src/server.ts:48-48 (registration)Calls the registration function to add the tool during server initialization.registerManageRepoSubscriptionTool(server);
- src/server.ts:18-18 (registration)Imports the registration function for the manage-repo-subscription tool.import { registerManageRepoSubscriptionTool } from "./tools/manage-repo-subscription.js";