Xray Alan Eşleme Şablonu

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

The description is consistent with the readOnly and idempotent annotations and indicates a simple retrieval with no side effects, but it adds no behavioral context beyond what the annotations already declare.

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 one short sentence, front-loaded with the action and object, and contains no filler or redundant information.

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 zero-parameter, read-only retrieval tool with an output schema, the description is sufficiently complete. It does not explain how the mapping template relates to the conversion sibling tools, but that is not required for the simple act of retrieving it.

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 tool has zero parameters, so there is no parameter behavior to document. The input schema fully covers the empty parameter set, and no additional parameter explanation is needed.

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 is a single, specific statement: 'Returns the Xray field mapping template.' It clearly identifies the action and the resource, and it is distinct enough from sibling tools that generate, lint, normalize, or convert test cases.

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 gives no guidance on when to use this tool versus related tools such as testcase_to_xray or testcase_to_xray_batch. An agent has to infer from the name that this template is likely a prerequisite for conversion.

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