qui_create_scan_directory

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

With no annotations, the description carries the burden of behavioral disclosure. It only mentions the HTTP verb and argument structure, but does not state that this creates a resource, whether authentication is needed, or what side effects occur. The POST verb hints at mutation but isn't explicit.

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 sentence that front-loads the endpoint and follows with argument conventions. Every word earns its place and there is no redundancy.

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 output schema covers return types, but the description does not explain what a scan directory is, what body fields are required, or any prerequisites. For a create operation, the agent would lack the domain details needed to construct a valid request. The mention of path variables is also generic and irrelevant for this fixed endpoint.

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 schema has a single generic 'arguments' property with no field descriptions (0% coverage). The description adds valuable structure by explaining how to route path variables, query values, and request body within the arguments object, which is essential for using the tool.

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 specifies the exact endpoint (POST /dir-scan/directories/) and the tool name indicates creation. While it doesn't explicitly say 'create a scan directory', the endpoint path and name make the purpose clear. It distinguishes from sibling tools by being the POST/create variant.

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 like qui_update_scan_directory or qui_list_scan_directories. The description only explains how to call the API, not the appropriate context.

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