Skip to main content
Glama

Read a Test Plan row

traceable_test_plan_read
Read-onlyIdempotent

Read a bound Test Plan row: the plan (with boundDocuments, every document bound to it, which all share its entries, archived ones marked archived=true and listed last), the columns the row shows, and every entry with its protocol TraceID, protocol cells, all column values (decision, rationale, result_text, test_notes, samples, location, equipment, result, assessment, baseline_notes, resolution), its evidence (a file carries its REF code as reference, which traceable_test_plan_evidence_add takes), the tester signature (if signed) and, for a protocol with test steps, each step (numbered from 1) with its text, acceptance criteria and recorded result. Entries are listed in the order their protocols joined the plan, the order the Test Plan row shows; a protocol added or moved later stays where it joined. Use it before traceable_test_plan_entry.

Input Schema

NameRequiredDescriptionDefault
rowYesIdentify the Test Plan row by itemId or atOrder (pass one).
documentIdYesThe document holding the Test Plan row

Schema Changelog

Changes observed during successful MCP inspections.

  1. First observed

TDQS

A4.1/5.0
Behavior4/5

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

Annotations already declare readOnly/idempotent/non-destructive, so the bar is lower, yet the description adds real behavior: archived documents are marked archived=true and sorted last, entries follow protocol-join order and do not reorder when a protocol is moved later, and steps are numbered from 1. It stops short of saying anything about size or response envelope, but the ordering semantics are genuinely valuable.

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

Conciseness3/5

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

The content is front-loaded with the resource, which is good, but it is delivered as one extremely long run-on sentence with a stacked parenthetical list of column names. Every clause carries information, yet the structure makes it hard to scan; breaking the ordering rules and return fields into separate sentences would help.

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

Completeness5/5

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

There is no output schema, so the description must carry the return contract, and it does: it names each returned component, the entry-level attributes, the evidence REF hook, and the ordering behavior. Nothing an agent needs to interpret the result of this nested-object read is missing.

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 coverage is 100%, and the schema already explains that `row` takes itemId or atOrder ('pass one') and that documentId holds the row. The description adds no formatting or disambiguation guidance beyond the structured fields, so the baseline of 3 applies.

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

Purpose5/5

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

States a specific verb and resource ('Read a bound Test Plan row') and then enumerates exactly what the read returns: plan, bound documents, columns, entries, evidence, signatures and protocol steps. It is clearly distinct from mutation siblings and explicitly contrasts itself with traceable_test_plan_entry.

Agents choose between tools based on descriptions. A clear purpose with a specific verb and resource helps agents select the right tool.

Usage Guidelines4/5

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

Closes with 'Use it before traceable_test_plan_entry', giving an explicit sequencing rule, and the evidence note tells the agent that the returned `reference` feeds traceable_test_plan_evidence_add. It gives clear usage context but no when-not conditions beyond that ordering hint.

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

Try in Browser

Glama MCP Gateway

Add one secure layer between your agents and this server.

Resources