Skip to main content
Glama

testrail_list_sections

Retrieve TestRail sections as a tree with full paths ('Parent > Child') and filter by text in the path to locate the right section for organizing test cases.

Instructions

List sections as a tree with full paths ("Parent > Child"). search filters by text in the path. project_id / suite_id default to TESTRAIL_PROJECT_ID / TESTRAIL_SUITE_ID.

Input Schema

TableJSON Schema
NameRequiredDescriptionDefault
searchNo
suite_idNo
project_idNo

Output Schema

TableJSON Schema
NameRequiredDescriptionDefault
resultYes

Schema Changelog

Changes observed during successful MCP inspections.

  1. First observedv0.1.0

TDQS

A3.7/5.0
Behavior3/5

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

With no annotations, the description carries the full burden. It discloses the return structure (tree with full paths) and default parameter resolution from env vars, which is useful, but says nothing about read-only safety, pagination, or 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.

Conciseness5/5

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

Two tight sentences with the core purpose and format front-loaded, followed by the parameter behavior. No wasted words.

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

Completeness4/5

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

An output schema exists, so return values need not be explained, and the description still notes the tree format. For a read-only list tool with optional params, this is nearly complete, though sibling differentiation is absent.

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

Parameters4/5

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

Schema coverage is 0%, so the description must compensate and it largely does: it explains `search` ('filters by text in the path') and the default resolution for `project_id`/`suite_id` from TESTRAIL_PROJECT_ID/TESTRAIL_SUITE_ID. It still doesn't describe what a suite vs project id selects, so not a 5.

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+resource ('List sections') and adds the output shape ('as a tree with full paths'). It does not explicitly differentiate from sibling testrail_list_suites, so it stops short of a 5.

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?

No explicit when-to-use or when-not guidance versus siblings like testrail_list_suites or testrail_list_cases. Usage is only implied by the resource name and the mention of defaults.

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