vrchat_get_notifications
Retrieve VRChat notifications to monitor friend requests, messages, and platform updates, enabling users to stay informed about social interactions and account activity.
Instructions
Retrieve a list of VRChat notifications.
Input Schema
TableJSON Schema
| Name | Required | Description | Default |
|---|---|---|---|
| type | No | Only send notifications of this type. Use "all" for all types. This parameter no longer does anything and is deprecated. | |
| sent | No | Return notifications sent by the user. Must be false or omitted. | |
| hidden | No | Whether to return hidden or non-hidden notifications. True only allowed on type "friendRequest". | |
| after | No | Only return notifications sent after this Date. Ignored if type is "friendRequest". | |
| n | No | The number of objects to return. Default: 60, Max: 100 | |
| offset | No | A zero-based offset from the default object sorting from where to start. |
Implementation Reference
- src/tools/notifications.ts:31-56 (handler)The handler function for the 'vrchat_get_notifications' tool. Authenticates the VRChat client, calls getNotifications on notificationsApi with provided parameters, returns JSON stringified data or error message.async (params) => { try { await vrchatClient.auth() const response = await vrchatClient.notificationsApi.getNotifications( params.type, params.sent, params.hidden, params.after, params.n || 60, params.offset || 0, ) return { content: [{ type: 'text', text: JSON.stringify(response.data, null, 2) }] } } catch (error) { return { content: [{ type: 'text', text: 'Failed to retrieve notifications: ' + error }] } } }
- src/tools/notifications.ts:11-30 (schema)Input schema using Zod for validating parameters of the 'vrchat_get_notifications' tool.{ type: z.string().optional().describe( 'Only send notifications of this type. Use "all" for all types. This parameter no longer does anything and is deprecated.' ), sent: z.boolean().optional().describe( 'Return notifications sent by the user. Must be false or omitted.' ), hidden: z.boolean().optional().describe( 'Whether to return hidden or non-hidden notifications. True only allowed on type "friendRequest".' ), after: z.string().optional().describe( 'Only return notifications sent after this Date. Ignored if type is "friendRequest".' ), n: z.number().min(1).max(100).optional().describe( 'The number of objects to return. Default: 60, Max: 100' ), offset: z.number().min(0).optional().describe( 'A zero-based offset from the default object sorting from where to start.' ), },
- src/tools/notifications.ts:6-57 (registration)Registers the 'vrchat_get_notifications' tool on the MCP server with name, description, schema, and handler function.server.tool( // Name 'vrchat_get_notifications', // Description 'Retrieve a list of VRChat notifications.', { type: z.string().optional().describe( 'Only send notifications of this type. Use "all" for all types. This parameter no longer does anything and is deprecated.' ), sent: z.boolean().optional().describe( 'Return notifications sent by the user. Must be false or omitted.' ), hidden: z.boolean().optional().describe( 'Whether to return hidden or non-hidden notifications. True only allowed on type "friendRequest".' ), after: z.string().optional().describe( 'Only return notifications sent after this Date. Ignored if type is "friendRequest".' ), n: z.number().min(1).max(100).optional().describe( 'The number of objects to return. Default: 60, Max: 100' ), offset: z.number().min(0).optional().describe( 'A zero-based offset from the default object sorting from where to start.' ), }, async (params) => { try { await vrchatClient.auth() const response = await vrchatClient.notificationsApi.getNotifications( params.type, params.sent, params.hidden, params.after, params.n || 60, params.offset || 0, ) return { content: [{ type: 'text', text: JSON.stringify(response.data, null, 2) }] } } catch (error) { return { content: [{ type: 'text', text: 'Failed to retrieve notifications: ' + error }] } } } )
- src/main.ts:37-37 (registration)Calls createNotificationsTools to register the notifications tools, including 'vrchat_get_notifications', on the main MCP server.createNotificationsTools(server, vrchatClient)