add_case

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

Annotations indicate this is a non-readonly, non-idempotent, non-destructive operation. The description adds the fact that field names must be valid and come from get_case_fields, but it does not disclose other behavioral traits such as return values, error conditions, or side effects. With annotations already covering the safety profile, the description provides only marginal additional transparency.

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 long, both sentences earning their place. It states the core purpose first, then adds the critical prerequisite about field names. There is no filler or redundancy, making it highly concise and well-structured.

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?

Given the tool's moderate complexity (three parameters, one nested object, no output schema), the description provides essential workflow context by pointing to get_case_fields. It does not explain return values or error behavior, but the rich schema descriptions and annotations cover most needs. The description is sufficient for an agent to invoke the tool correctly in a typical workflow.

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%, and each parameter (title, section_id, fields) has a thorough description, including the flat map nature of fields and the need to use system_name values. The main description adds no significant parameter semantics beyond what the schema already provides. Baseline 3 is appropriate due to full schema coverage.

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 immediately states the tool's function: 'Create a new test case in TestRail.' This is a specific verb+resource that clearly distinguishes it from sibling tools like update_case or get_case. The addition of the TestRail platform name adds context.

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 explains a key prerequisite: knowing valid field names returned by get_case_fields. This gives the agent a clear actionable step before calling add_case. It does not explicitly mention when not to use the tool (e.g., for updates), but the name and purpose make that distinction obvious. The guidance is valuable and directly references a sibling tool.

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