users_list
Retrieve and manage VPN user accounts with paginated results for administrative oversight.
Instructions
List all Remnawave VPN users with pagination
Input Schema
TableJSON Schema
| Name | Required | Description | Default |
|---|---|---|---|
| start | No | Offset for pagination | |
| size | No | Number of users to return |
Implementation Reference
- src/tools/users.ts:14-21 (handler)The handler function for the 'users_list' tool, which calls client.getUsers with pagination parameters.
async ({ start, size }) => { try { const result = await client.getUsers(start, size); return toolResult(result); } catch (e) { return toolError(e); } }, - src/tools/users.ts:10-13 (schema)The input schema (zod) defining the 'start' and 'size' parameters for the 'users_list' tool.
{ start: z.number().default(0).describe('Offset for pagination'), size: z.number().default(25).describe('Number of users to return'), }, - src/tools/users.ts:7-22 (registration)The registration of the 'users_list' tool within the McpServer instance.
server.tool( 'users_list', 'List all Remnawave VPN users with pagination', { start: z.number().default(0).describe('Offset for pagination'), size: z.number().default(25).describe('Number of users to return'), }, async ({ start, size }) => { try { const result = await client.getUsers(start, size); return toolResult(result); } catch (e) { return toolError(e); } }, );