List KB Documents

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

The annotations already declare readOnlyHint, openWorldHint, and idempotentHint, covering the safety profile. However, the description adds no behavioral context beyond the one-line statement – no mention of return format, pagination, or scope limitations. With a good annotation set, a score of 2 is appropriate because the description adds minimal value over annotations.

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 concise sentence that is front-loaded with the verb 'List'. No filler words; it earns its place.

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?

The tool is simple (1 param, no output schema), but the description is minimal. It does not explain what fields are returned (e.g., document IDs, names) or mention pagination. Since the output schema is absent, the description should carry more weight; for a list operation, this is a gap.

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?

The input schema documents the single parameter raq_id with a clear description 'Knowledge base id', covering 100% of parameters. The description doesn't add any additional meaning, but since schema coverage is complete, the baseline of 3 applies.

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 'List the documents indexed in a knowledge base' clearly states the action (list) and the resource (documents in a KB), with a specific scope. It distinguishes from sibling tools like lyzr_kb_list (which likely lists KBs) by focusing on documents within a KB.

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 explicit guidance on when to use this tool versus alternatives like lyzr_kb_list or lyzr_kb_get. It doesn't mention any exclusions or context. Given the large sibling set, this lack of guidance makes it hard for an agent to decide which tool to invoke.

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