list_users
Retrieve a paginated listing of users from a BookStack wiki system, with options to sort results and control page size for efficient user management.
Instructions
Get a listing of users in the system
Input Schema
TableJSON Schema
| Name | Required | Description | Default |
|---|---|---|---|
| count | No | Number of items per page | |
| page | No | Page number for pagination | |
| sort | No | Sort parameter |
Implementation Reference
- src/tools/search-user-tools.ts:357-361 (handler)Executes the list_users tool by parsing pagination arguments, fetching users via BookStackClient.getUsers, and formatting the paginated response.case "list_users": { const params = PaginationSchema.parse(args); const result = await client.getUsers(params); return formatApiResponse(result.data, result.total); }
- src/tools/search-user-tools.ts:38-49 (schema)Defines the input schema for the list_users tool, supporting optional pagination and sorting parameters.{ name: "list_users", description: "Get a listing of users in the system", inputSchema: { type: "object", properties: { page: { type: "number", description: "Page number for pagination" }, count: { type: "number", description: "Number of items per page" }, sort: { type: "string", description: "Sort parameter" }, }, }, },
- src/index.ts:102-122 (registration)Registers 'list_users' in the dispatch array for search/user tools, routing calls to handleSearchAndUserTool.// Search and user tools const searchUserToolNames = [ "search_all", "list_users", "get_user", "create_user", "update_user", "delete_user", "list_roles", "get_role", "create_role", "update_role", "delete_role", "list_attachments", "get_attachment", "delete_attachment", "list_images", "get_image", "update_image", "delete_image", ];
- src/index.ts:56-59 (registration)Includes the list_users tool (via createSearchAndUserTools) in the complete list of available tools served by the MCP server.const allTools: Tool[] = [ ...createContentTools(bookStackClient), ...createSearchAndUserTools(bookStackClient), ];