vrchat_list_favorited_worlds
Retrieve and organize favorited worlds in VRChat using customizable filters, sorting options, and result limits through the VRChat MCP Server.
Instructions
List favorited worlds by query filters.
Input Schema
TableJSON Schema
| Name | Required | Description | Default |
|---|---|---|---|
| featured | No | Filters on featured results | |
| n | No | The number of objects to return, min 1, max 100 | |
| order | No | Sort results in ascending or descending order | |
| sort | No | The sort order of the results |
Implementation Reference
- src/tools/worlds.ts:17-41 (handler)Handler function for vrchat_list_favorited_worlds tool that authenticates the VRChat client and fetches favorited worlds using the provided parameters, returning JSON data or error message.async (params) => { try { await vrchatClient.auth() const worlds = await vrchatClient.worldsApi.getFavoritedWorlds( params.featured, params.sort, params.n, params.order, ) return { content: [{ type: 'text', text: JSON.stringify(worlds.data, null, 2) }] } } catch (error) { return { content: [{ type: 'text', text: 'Failed to get favorited worlds: ' + error }] } } } )
- src/tools/worlds.ts:11-16 (schema)Input schema using Zod defining optional parameters: featured (boolean), sort (enum), n (number 1-100), order (ascending/descending).{ featured: z.boolean().optional().describe('Filters on featured results'), sort: z.enum(['popularity', 'heat', 'trust', 'shuffle', 'random', 'favorites', 'reportScore', 'reportCount', 'publicationDate', 'labsPublicationDate', 'created', '_created_at', 'updated', '_updated_at', 'order', 'relevance', 'magic', 'name']).optional().describe('The sort order of the results'), n: z.number().min(1).max(100).optional().describe('The number of objects to return, min 1, max 100'), order: z.enum(['ascending', 'descending']).optional().describe('Sort results in ascending or descending order'), },
- src/tools/worlds.ts:7-41 (registration)Registration of the vrchat_list_favorited_worlds tool using McpServer.tool() with name, description, input schema, and handler function.// Name 'vrchat_list_favorited_worlds', // Description 'List favorited worlds by query filters.', { featured: z.boolean().optional().describe('Filters on featured results'), sort: z.enum(['popularity', 'heat', 'trust', 'shuffle', 'random', 'favorites', 'reportScore', 'reportCount', 'publicationDate', 'labsPublicationDate', 'created', '_created_at', 'updated', '_updated_at', 'order', 'relevance', 'magic', 'name']).optional().describe('The sort order of the results'), n: z.number().min(1).max(100).optional().describe('The number of objects to return, min 1, max 100'), order: z.enum(['ascending', 'descending']).optional().describe('Sort results in ascending or descending order'), }, async (params) => { try { await vrchatClient.auth() const worlds = await vrchatClient.worldsApi.getFavoritedWorlds( params.featured, params.sort, params.n, params.order, ) return { content: [{ type: 'text', text: JSON.stringify(worlds.data, null, 2) }] } } catch (error) { return { content: [{ type: 'text', text: 'Failed to get favorited worlds: ' + error }] } } } )