Skip to main content
Glama
gracexiaowork

testrail-mcp-server

testrail_get_sections

Retrieves sections from a TestRail project, optionally filtered by suite, for organizing and locating test cases within a project structure.

Instructions

Get sections from a project (optionally filtered by suite)

Input Schema

TableJSON Schema
NameRequiredDescriptionDefault
suite_idNoOptional suite ID to filter sections
project_idYesThe ID of the project

Schema Changelog

Changes observed during successful MCP inspections.

  1. First observedv1.0.0

TDQS

B3.2/5.0
Behavior2/5

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

No annotations are provided, so the description carries the full burden of behavioral disclosure. It conveys a read operation by implication but does not state permissions required, whether results are paginated, or what the return structure looks like, which is a notable gap for a list tool with zero annotation coverage.

Agents need to know what a tool does to the world before calling it. Descriptions should go beyond structured annotations to explain consequences.

Conciseness4/5

Is the description appropriately sized, front-loaded, and free of redundancy?

A single efficient sentence that front-loads the core action and tucks the optional filter into a parenthetical. Nothing is wasted, though it is minimal rather than rich.

Shorter descriptions cost fewer tokens and are easier for agents to parse. Every sentence should earn its place.

Completeness3/5

Given the tool's complexity, does the description cover enough for an agent to succeed on first attempt?

For a simple two-parameter read tool with no output schema, the description is minimally adequate. It covers the resource and the filter but omits return-format or pagination context, leaving an agent with just enough to call it.

Complex tools with many parameters or behaviors need more documentation. Simple tools need less. This dimension scales expectations accordingly.

Parameters3/5

Does the description clarify parameter syntax, constraints, interactions, or defaults beyond what the schema provides?

Schema description coverage is 100%, so both parameters are already documented in the schema, making 3 the baseline. The description's 'optionally filtered by suite' adds mild semantic clarification that suite_id narrows the result set, but nothing beyond the schema.

Input schemas describe structure but not intent. Descriptions should explain non-obvious parameter relationships and valid value ranges.

Purpose4/5

Does the description clearly state what the tool does and how it differs from similar tools?

States a specific verb ('Get') and resource ('sections') scoped to a project, with an optional suite filter. This distinguishes it from the singular sibling testrail_get_section, though it never names 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.

Usage Guidelines3/5

Does the description explain when to use this tool, when not to, or what alternatives exist?

The parenthetical 'optionally filtered by suite' implies when the suite_id matters, giving mild usage context. However, there is no explicit guidance on when to use this list tool versus testrail_get_section or testrail_get_cases, so usage is only implied.

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