bookstack_help

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

No annotations are provided, so the description carries the full burden of behavioral disclosure. It states the tool provides 'contextual guidance' but doesn't describe what that means in practice—e.g., whether it returns instructional text, examples, error resolutions, or structured advice. It also omits key behavioral traits like whether it's read-only, requires authentication, has rate limits, or affects system state. The description is too vague to inform an agent adequately.

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?

The description is a single, efficient sentence that front-loads the core purpose ('Interactive help system providing contextual guidance'). There's no wasted verbiage or redundancy. However, it could be slightly more structured by hinting at the tool's output or usage scenarios, but it remains appropriately concise for a simple help tool.

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?

Given the lack of annotations and output schema, the description is incomplete for a tool with two parameters. It doesn't explain what the tool returns (e.g., text guidance, structured data), how it integrates with sibling tools, or behavioral aspects like safety or performance. For a help system, users need to know what kind of guidance to expect, but the description leaves this ambiguous, making it inadequate for full contextual understanding.

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%, with both parameters ('topic' and 'context') well-documented in the schema, including an enum for 'topic.' The description adds no parameter-specific information beyond what the schema provides—it doesn't explain how 'topic' choices relate to guidance or how 'context' influences responses. Since the schema does the heavy lifting, the baseline score of 3 is appropriate, but the description contributes no additional value.

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 tool's purpose as 'Interactive help system providing contextual guidance for LLM tool usage,' specifying the verb ('providing guidance') and resource ('LLM tool usage'). It distinguishes itself from sibling tools, which are all CRUD operations for BookStack resources, by being a meta-tool for guidance rather than direct content manipulation. However, it doesn't specify what 'contextual guidance' entails (e.g., examples, explanations, troubleshooting).

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 provides no guidance on when to use this tool versus alternatives. It doesn't mention prerequisites (e.g., use when confused about tool usage), exclusions (e.g., not for direct data operations), or refer to sibling tools like 'bookstack_usage_examples' or 'bookstack_error_guides' that might offer overlapping functionality. Usage is implied only through the general term 'guidance.'

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