user_list
Retrieve a list of users in the Pickaxe studio with their product access and usage statistics for management and analytics purposes.
Instructions
List all users in the Pickaxe studio with their product access and usage stats.
Input Schema
TableJSON Schema
| Name | Required | Description | Default |
|---|---|---|---|
| studio | No | Studio name to use. Available: STAGING, MAIN, DEV, PRODUCTION. Default: PRODUCTION | |
| skip | No | Number of users to skip. Default: 0 | |
| take | No | Number of users to return. Default: 10 |
Implementation Reference
- src/index.ts:523-528 (handler)Handler for the user_list tool: extracts skip and take parameters (defaulting to 0 and 10), makes a GET request to the Pickaxe API endpoint `/studio/user/list` with pagination query params, and returns the JSON-stringified response.
case "user_list": { const skip = args.skip ?? 0; const take = args.take ?? 10; const result = await pickaxeRequest(`/studio/user/list?skip=${skip}&take=${take}`, "GET", undefined, studio); return JSON.stringify(result, null, 2); } - src/index.ts:261-277 (registration)Registration of the user_list tool in the static tools array returned by ListToolsRequestHandler. Includes name, description, and input schema definition (with studio param reference, skip/take optional).
name: "user_list", description: "List all users in the Pickaxe studio with their product access and usage stats.", inputSchema: { type: "object", properties: { studio: studioParam, skip: { type: "number", description: "Number of users to skip. Default: 0", }, take: { type: "number", description: "Number of users to return. Default: 10", }, }, }, }, - src/index.ts:263-276 (schema)Input schema for the user_list tool: object with optional 'studio' (referencing studioParam), 'skip' number (default 0), and 'take' number (default 10). No required fields.
inputSchema: { type: "object", properties: { studio: studioParam, skip: { type: "number", description: "Number of users to skip. Default: 0", }, take: { type: "number", description: "Number of users to return. Default: 10", }, }, },