bookstack_shelves_list

Does the description disclose side effects, auth requirements, rate limits, or destructive behavior?

With no annotations provided, the description carries full burden. It discloses key behaviors: visibility is limited to authenticated user, pagination is supported, and filtering options exist. However, it doesn't mention rate limits, authentication requirements beyond 'authenticated user', error conditions, or response format details.

Agents need to know what a tool does to the world before calling it. Descriptions should go beyond structured annotations to explain consequences.

Is the description appropriately sized, front-loaded, and free of redundancy?

Two sentences with zero waste. First sentence states purpose and key features. Second sentence provides helpful context about what shelves are. Perfectly front-loaded and appropriately sized.

Shorter descriptions cost fewer tokens and are easier for agents to parse. Every sentence should earn its place.

Given the tool's complexity, does the description cover enough for an agent to succeed on first attempt?

For a list operation with 100% schema coverage but no annotations or output schema, the description provides adequate context about scope and capabilities. It could be more complete by mentioning response format or typical use cases, but covers the essential purpose and constraints well given the available structured data.

Complex tools with many parameters or behaviors need more documentation. Simple tools need less. This dimension scales expectations accordingly.

Does the description clarify parameter syntax, constraints, interactions, or defaults beyond what the schema provides?

Schema description coverage is 100%, so the schema fully documents all 4 parameters. The description adds minimal value beyond the schema by mentioning 'pagination and filtering options' which aligns with count/offset and filter parameters, but doesn't provide additional semantic context beyond what's in the parameter descriptions.

Input schemas describe structure but not intent. Descriptions should explain non-obvious parameter relationships and valid value ranges.

Does the description clearly state what the tool does and how it differs from similar tools?

The description clearly states the action ('List all bookshelves'), specifies the resource ('bookshelves'), and provides scope ('visible to the authenticated user'). It distinguishes from siblings like bookstack_shelves_create/read/update/delete by focusing on listing rather than CRUD operations on individual shelves.

Agents choose between tools based on descriptions. A clear purpose with a specific verb and resource helps agents select the right tool.

Does the description explain when to use this tool, when not to, or what alternatives exist?

The description implies usage for listing shelves with pagination/filtering, but doesn't explicitly state when to use this tool versus alternatives like bookstack_search or bookstack_books_list for finding content. No explicit exclusions or prerequisites are mentioned.

Agents often have multiple tools that could apply. Explicit usage guidance like "use X instead of Y when Z" prevents misuse.