list_users
Retrieve and manage user data with pagination on TeamRetro MCP Server. Specify limit and offset to filter results for efficient user list retrieval.
Instructions
List users with pagination
Input Schema
TableJSON Schema
| Name | Required | Description | Default |
|---|---|---|---|
| limit | No | number | |
| offset | No | number |
Implementation Reference
- src/features/users/service.ts:12-22 (handler)Core handler function that executes the API request to list users with optional pagination parameters offset and limit.
async listUsers(params?: { offset?: number; limit?: number; }): Promise<ListApiResponse<User>> { const searchString = createSearchParams({ offset: { value: params?.offset }, limit: { value: params?.limit }, }); return this.get<ListApiResponse<User>>(`/v1/users?${searchString}`); } - src/features/users/tools.ts:12-17 (registration)Registration of the 'list_users' tool, including schema, description, and wrapper handler that calls the service.
list_users: { schema: paginationSchema, description: "List users with pagination using offset and limit parameters to control the number of results returned", handler: async (args: { offset?: number; limit?: number }) => createToolResponse(usersService.listUsers(args)), }, - src/schemas/generic.ts:14-17 (schema)Zod input schema for pagination parameters (offset, limit) used by the list_users tool.
export const paginationSchema = z.object({ offset: z.number().int().min(0).default(0).describe("number"), limit: z.number().int().min(1).max(1000).default(1000).describe("number"), }); - src/tools.ts:13-22 (registration)Top-level aggregation and registration of all feature tools including userTools (which contains list_users).
const tools = { ...userTools, ...teamTools, ...teamMembersTools, ...actionTools, ...retrospectiveTools, ...agreementTools, ...healthModelTools, ...healthCheckTools, }; - src/features/users/service.ts:71-72 (helper)Export of the usersService instance used by the list_users handler.
export const usersService = new UsersService();