Xray Create Folder

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

Annotations already cover the safety profile (readOnlyHint=false, idempotentHint=false, destructiveHint=false, openWorldHint=true), so the description only needs to add context. It notes that tests can be moved into the new folder in the same call, which is useful, but says nothing about failure modes (existing path, invalid project/test plan) or permission requirements.

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?

A single, front-loaded sentence with no filler; the resource and the two placement modes come first, and the optional behavior comes last.

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 4-parameter create tool with an output schema and full annotation coverage, this is nearly sufficient: it names the two folder locations and the optional test attachment. It leaves out only edge-case behavior (path collisions, failure conditions), which keeps it short of a 5.

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 baseline is 3. The description reinforces the project-vs-test_plan mode distinction but adds no format, syntax, or constraint detail (e.g. path normalization, whether tests are moved or copied) beyond what the schema already documents.

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?

States a specific verb (Create) and resource (folder), and scopes it to two concrete parent locations ('a project's Test Repository or in a Test Plan') with an optional payload. This distinguishes it cleanly from sibling folder operations like xray_rename_folder, xray_move_folder, and xray_delete_folder.

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?

Usage is implied rather than stated: the description hints at the two modes via 'Test Repository or in a Test Plan' and the optional Tests, and the schema's project/test_plan params disambiguate them. But it never says when to prefer this over xray_move_to_folder for relocating existing tests, nor any prerequisites.

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