vrchat_list_invite_messages
Retrieve invite messages for a specific VRChat user. Specify user ID and message type to view invitation history and responses.
Instructions
Returns a list of all the users Invite Messages. Admin Credentials are required to view messages of other users!
Input Schema
TableJSON Schema
| Name | Required | Description | Default |
|---|---|---|---|
| userId | Yes | Must be a valid user ID | |
| messageType | Yes | The type of message to fetch |
Implementation Reference
- src/tools/invites.ts:15-33 (handler)The handler function for the 'vrchat_list_invite_messages' tool. It authenticates the VRChat client, fetches invite messages using the InviteApi.getInviteMessages method, and returns the JSON-stringified response or an error message.
async (params) => { try { await vrchatClient.auth() const response = await vrchatClient.inviteApi.getInviteMessages(params.userId, params.messageType) return { content: [{ type: 'text', text: JSON.stringify(response.data, null, 2) }] } } catch (error) { return { content: [{ type: 'text', text: 'Failed to get invite messages: ' + error }] } } } - src/tools/invites.ts:11-14 (schema)Input schema defined using Zod, specifying 'userId' as a non-empty string and 'messageType' as an enum of invite message types.
{ userId: z.string().min(1).describe('Must be a valid user ID'), messageType: z.enum(['message', 'response', 'request', 'requestResponse']).describe('The type of message to fetch') }, - src/tools/invites.ts:6-34 (registration)Registers the 'vrchat_list_invite_messages' tool on the MCP server within the createInvitesTools function, including name, description, input schema, and inline handler.
server.tool( // Name 'vrchat_list_invite_messages', // Description 'Returns a list of all the users Invite Messages. Admin Credentials are required to view messages of other users!', { userId: z.string().min(1).describe('Must be a valid user ID'), messageType: z.enum(['message', 'response', 'request', 'requestResponse']).describe('The type of message to fetch') }, async (params) => { try { await vrchatClient.auth() const response = await vrchatClient.inviteApi.getInviteMessages(params.userId, params.messageType) return { content: [{ type: 'text', text: JSON.stringify(response.data, null, 2) }] } } catch (error) { return { content: [{ type: 'text', text: 'Failed to get invite messages: ' + error }] } } } ) - src/main.ts:36-36 (registration)Calls createInvitesTools in the main server setup, which triggers the registration of the invites tools including 'vrchat_list_invite_messages'.
createInvitesTools(server, vrchatClient)