TestRail MCP Server

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

No annotations provided, so description carries full disclosure burden. It reveals valuable behavioral specifics: creates a new case (not update), uses hardcoded template_id=4, and populates custom_testrail_bdd_scenario field. Missing safety profile (idempotency, destructive potential) and error behavior.

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 dense sentences with zero waste. Front-loaded with action (Imports/uploads), followed by implementation details, then parameter requirements. Every clause provides unique information not duplicating schema or annotations.

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?

Adequate for input parameters but lacks return value description critical for a creation tool, especially since no output schema exists. Should specify what gets returned (e.g., created case ID) to enable downstream tool use.

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 has 100% coverage, but description adds significant value by specifying Gherkin format requirements ('including Feature:, Scenario:, Given/When/Then') and emphasizing REQUIRED constraints. Provides concrete syntax examples beyond schema's generic 'plain text' 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?

Clear specific verb ('Imports/uploads') and resource ('.feature file/Gherkin BDD scenario'). Explicitly distinguishes from sibling addCase by disclosing implementation details: BDD template (template_id=4) and specific field (custom_testrail_bdd_scenario) that only this tool uses.

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?

Provides implicit usage context through BDD-specific terminology (Gherkin, template_id=4), but lacks explicit guidance on when to choose this over addCase or other alternatives. No 'when not to use' or prerequisite information.

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