user_list
List users in a Pickaxe studio with their product access and usage statistics for managing user permissions and monitoring activity.
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)The handler function for the 'user_list' tool. It extracts optional pagination parameters (skip and take) from the input arguments, constructs a GET request to the Pickaxe API endpoint '/studio/user/list', executes the request using the shared pickaxeRequest helper, and returns the JSON-formatted result.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:260-277 (registration)The registration of the 'user_list' tool in the tools array, including its name, description, and input schema definition. This object is returned by the listTools handler.{ 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:264-276 (schema)Input schema for the 'user_list' tool, defining optional parameters: studio (shared param), skip (number, default 0), and take (number, default 10).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", }, }, },