vrchat_list_favorited_worlds
Retrieve and filter your favorited VRChat worlds by popularity, date, or other criteria to quickly find preferred virtual environments.
Instructions
List favorited worlds by query filters.
Input Schema
TableJSON Schema
| Name | Required | Description | Default |
|---|---|---|---|
| featured | No | Filters on featured results | |
| sort | No | The sort order of the results | |
| n | No | The number of objects to return, min 1, max 100 | |
| order | No | Sort results in ascending or descending order |
Implementation Reference
- src/tools/worlds.ts:17-41 (handler)Handler function that authenticates the VRChat client and retrieves the list of favorited worlds based on the provided query parameters, returning the JSON data or an 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)Zod schema defining the optional input parameters for filtering and sorting favorited worlds: featured, sort, n, order.
{ 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 server.tool, including 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 }] } } } )