Skip to main content
Glama

Traceable

Record Test Plan entry data

traceable_test_plan_entry
DestructiveIdempotent

Record data in one Test Plan entry: pass fields as {column: value}. Entry columns: decision (include | exclude), rationale, result_text, test_notes, samples, location, equipment (one dated register label per line), result (pass | fail | "" to clear; derived from the steps when the protocol has steps), assessment, baseline_notes, resolution (passed | failed | passed_with_deviation | failure_accepted | "" for the derived default). With step (numbered from 1) the fields are that test step's: result_text, notes, result. Same validation and limits as the editor. Evidence is traceable_test_plan_evidence. Tester is an electronic signature and cannot be applied by an agent. The Test Plan row goes to review.

Input Schema

TableJSON Schema
NameRequiredDescriptionDefault
rowYesIdentify the Test Plan row by itemId or atOrder (pass one).
stepNoA test step, numbered from 1; omit for the entry's own columns
entryYesIdentify the entry by entryId or protocol (pass one).
fieldsYesColumn → value, e.g. {"result_text":"Observed 12 ms","result":"pass"}
documentIdYesThe document holding the Test Plan row

Schema Changelog

Changes observed during successful MCP inspections.

  1. First observed

TDQS

A4.4/5.0
Behavior4/5

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

Annotations declare destructive/write/idempotent but the description adds real behavior: values can be cleared with an empty string, result is derived from steps when the protocol has steps, resolution has a derived default, and the row is pushed to review. The agent-signature restriction is the single most valuable disclosure. It still doesn't spell out overwrite semantics for omitted columns.

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?

Front-loaded with the core instruction, then column semantics, then step behavior, then workflow notes. Dense but every clause carries semantic load; only the trailing review sentence is arguably peripheral.

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?

For a nested, 5-parameter mutation with no output schema and destructive annotation, the description covers value vocabularies, step scoping, evidence routing, signature limits, and post-write review state. It omits only return/confirmation behavior and permission requirements.

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

Parameters5/5

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

Schema coverage is 100%, so the baseline is 3, but the description goes well beyond it by enumerating the allowed values the schema itself does not constrain (decision include|exclude, result pass|fail|empty, resolution passed|failed|passed_with_deviation|failure_accepted|empty), documenting the per-line format of `equipment`, and redefining `step`'s scoped field set.

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 ('Record data in one Test Plan entry') and immediately explains the payload shape. It distinguishes itself from traceable_test_plan_read (which supplies the entry id) and from traceable_test_plan_evidence, so an agent can route correctly without opening schemas.

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?

Explicitly routes evidence to traceable_test_plan_evidence and states a hard when-not: the tester signature 'cannot be applied by an agent'. It also clarifies when to pass `step` versus entry-level columns. It stops short of stating prerequisites, such as needing entryId/protocol from a prior read, in a prescriptive when-to-use form.

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