Remove Table Documentation

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

Annotations already declare destructiveHint=true and readOnlyHint=false, which the description aligns with. The description adds minimal context beyond annotations, such as implying that only documentation is removed and not the table itself, but it does not elaborate on side effects or irreversibility.

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 extremely concise and front-loaded, consisting of a single sentence that directly states the action and target. Every word earns its place, and there is no filler or repetition.

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 simple deletion tool with schema and annotations, the description is adequate but leaves gaps. There is no output schema, and the description does not mention whether the operation is synchronous or asynchronous, nor does it clarify that the table itself is not deleted. The async sibling tool further highlights the missing context.

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 coverage is 100%, with both parameters ('table_name' and 'rag_config_id') already described. The tool description adds no additional meaning or usage details beyond the schema, so the baseline of 3 is appropriate.

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 states a specific action ('Remove') and resource ('saved documentation for a table'), making its primary purpose clear. It distinguishes from save/get sibling tools but does not differentiate between the synchronous remove and the async 'remove_documentation_task' sibling.

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?

No guidance is provided on when to use this tool versus alternatives. There is a sibling 'lyzr_semantic_model_remove_documentation_task' that likely handles asynchronous removal, but the description does not mention it or any use-case caveats.

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