list_pages
Retrieve a paginated list of pages available in BookStack, with options to sort results and control the number of items displayed per page.
Instructions
Get a listing of pages visible to the user
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/content-tools.ts:671-675 (handler)Handler logic for the 'list_pages' tool: parses arguments using PaginationSchema, fetches pages from BookStackClient, and returns formatted paginated response.case "list_pages": { const params = PaginationSchema.parse(args); const result = await client.getPages(params); return formatApiResponse(result.data, result.total); }
- src/tools/content-tools.ts:295-306 (schema)Tool definition including name, description, and input schema for pagination parameters (page, count, sort).{ name: "list_pages", description: "Get a listing of pages visible to the user", 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:76-126 (registration)'list_pages' is registered in the contentToolNames array, which determines if handleContentTool should be called for tool execution.const contentToolNames = [ "list_books", "get_book", "create_book", "update_book", "delete_book", "export_book", "list_chapters", "get_chapter", "create_chapter", "update_chapter", "delete_chapter", "export_chapter", "list_pages", "get_page", "create_page", "update_page", "delete_page", "export_page", "list_shelves", "get_shelf", "create_shelf", "update_shelf", "delete_shelf", ]; // 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", ]; if (contentToolNames.includes(name)) { result = await handleContentTool(name, args, bookStackClient); } else if (searchUserToolNames.includes(name)) {