Xray Import Execution Results Json

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

Annotations declare the write/safety profile (readOnly=false, destructive=false, idempotent=false, openWorld=true), so the description only needs to add beyond that. It usefully discloses create-or-update behavior, the testExecutionKey/info targeting mechanism, and that test_execution_info works via multipart import. It does not warn about non-idempotent re-imports (duplicate executions), a minor gap.

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?

Three short sentences, front-loaded with the purpose and scoping follow-ups. Every sentence carries information; no padding.

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?

An output schema exists, so return values need no explanation. The description covers the main behavioral nuance (create vs update, multipart info). The one inconsistency is that the name/description say "JSON" while the format enum accepts cucumber and behave reports, which an agent must infer from the schema alone.

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 schema already documents format, results, and test_execution_info. The description reinforces test_execution_info's role but adds no syntax or format detail beyond the schema. Baseline 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?

States a specific verb and resource ("Import JSON test results into Xray") and adds scope ("creating or updating a Test Execution"). The JSON framing distinguishes it from xray_import_execution_results_xml, though it doesn't name that sibling explicitly.

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?

Describes the create-vs-update targeting conditions ("target an existing execution via testExecutionKey or describe a new one in info"), which is useful usage context. However, it never states when to choose this tool over the xml/cucumber import siblings or when not to use it.

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