vrchat_search_groups
Find VRChat groups by name or short code to discover communities, manage memberships, and connect with users in the virtual world.
Instructions
Search VRChat groups by name or shortCode
Input Schema
TableJSON Schema
| Name | Required | Description | Default |
|---|---|---|---|
| query | Yes | Query to search for, can be either Group Name or Group shortCode | |
| offset | No | A zero-based offset from the default object sorting | |
| n | No | The number of objects to return |
Implementation Reference
- src/tools/groups.ts:34-64 (registration)Full registration of the 'vrchat_search_groups' tool, including input schema and handler function.
'vrchat_search_groups', 'Search VRChat groups by name or shortCode', { query: z.string().describe('Query to search for, can be either Group Name or Group shortCode'), offset: z.number().min(0).optional().describe('A zero-based offset from the default object sorting'), n: z.number().min(1).max(100).optional().describe('The number of objects to return') }, async (args) => { try { await vrchatClient.auth() const response = await vrchatClient.groupsApi.searchGroups( args.query, args.offset, args.n ) return { content: [{ type: 'text', text: JSON.stringify(response.data, null, 2) }] } } catch (error) { return { content: [{ type: 'text', text: 'Failed to search groups: ' + error }] } } } ) - src/tools/groups.ts:41-63 (handler)The handler function that authenticates the VRChat client and performs the group search using the groupsApi.searchGroups method, returning the JSON response or error.
async (args) => { try { await vrchatClient.auth() const response = await vrchatClient.groupsApi.searchGroups( args.query, args.offset, args.n ) return { content: [{ type: 'text', text: JSON.stringify(response.data, null, 2) }] } } catch (error) { return { content: [{ type: 'text', text: 'Failed to search groups: ' + error }] } } } - src/tools/groups.ts:36-40 (schema)Zod schema defining the input parameters for the tool: query (required string), offset (optional number), n (optional number between 1-100).
{ query: z.string().describe('Query to search for, can be either Group Name or Group shortCode'), offset: z.number().min(0).optional().describe('A zero-based offset from the default object sorting'), n: z.number().min(1).max(100).optional().describe('The number of objects to return') },