addBdd

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

No annotations are provided, so the description carries the full burden. It explains the tool creates a new test case with a specific template and populates a field, but does not disclose potential side effects, prerequisites (like section existence), or error conditions. The term 'imports/uploads' might be slightly misleading as it accepts raw text, not a file upload.

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 two sentences with no fluff. The first sentence clearly states the purpose, and the second emphasizes required parameters. Every sentence earns its place.

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?

With no output schema, the description should ideally hint at the return value (e.g., the created case ID or success confirmation). It also doesn't mention if the section must already exist or error handling, which are important for a mutation tool with two required parameters.

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 descriptions for both parameters. The description adds value by specifying that featureContent must include 'Feature:', 'Scenario:', and Given/When/Then, which is beyond the schema's 'raw Gherkin content' description.

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 clearly states the tool imports/uploads a .feature file (Gherkin BDD scenario) into TestRail, creating a new test case with the BDD template. It uses specific verbs and resources, and distinguishes itself from siblings like addCase by focusing on BDD scenarios.

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 explicitly lists the required parameters (sectionId, featureContent) and provides context on the template and field. While it doesn't directly mention when not to use it, the sibling tool addCase implies the alternative for regular cases, offering sufficient guidance.

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