Skip to main content
Glama

Validate a structured ZCode result

zcode_structured_result
Read-only

Recover the original schema and optional domain rule/input from a session, then validate the final JSON answer so invalid, unfinished, failed, or cancelled tasks are rejected.

Instructions

Recover the original schema and optional domainRule/input from the session and validate the final JSON answer. Invalid, unfinished, failed and cancelled tasks never count as valid.

Tool call template

Replace each placeholder with a value matching the input schema. Only required parameters are included; add optional parameters as needed.

{
  "id": 1,
  "jsonrpc": "2.0",
  "method": "tools/call",
  "params": {
    "arguments": {
      "taskId": "<taskId>"
    },
    "name": "zcode_structured_result"
  }
}

Input Schema

NameRequiredDescriptionDefault
taskIdYes
domainRuleNo

Schema Changelog

Changes observed during successful MCP inspections.

  1. First observedv0.3.0

TDQS

A3.6/5.0
Behavior4/5

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

Annotations already declare a safe read operation (readOnlyHint=true, openWorldHint=false), and the description adds genuine context beyond them: it pulls the schema and optional domainRule/input out of the session state, and it defines the validity rule so the agent knows such tasks are not counted. It stops short of describing what a failing validation returns.

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?

Two compact sentences with the core action front-loaded and the validity caveat immediately after; no filler. It is slightly dense and could separate the return-value question, but nothing is wasted.

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 read-only validation tool with two parameters, no output schema, and no annotation covering returns, the definition should say what comes back (a verdict? the recovered schema? validation errors?). It defines the input side adequately but leaves the response shape entirely unspecified.

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 0%, so the description must carry the burden. It names both taskId (implicitly, as the session reference) and domainRule, and clarifies that domainRule is optional and may be recovered from the session rather than supplied, which the bare schema does not convey. It does not explain the accepted domainRule enum values (section-outline-v1, section-outline-microbatch-v1) or the taskId pattern, so the compensation is partial.

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?

The description gives a specific verb and resource: recover the original schema and validate the final JSON answer for a session's structured result. It is clear what the tool does, but it never contrasts itself with the similarly named zcode_result, swarm_structured_result, or zcode_run_structured siblings, leaving an agent to guess which of these to pick.

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?

Usage is only implied: the note that invalid, unfinished, failed and cancelled tasks never count as valid tells you the tool renders a verdict, but there is no explicit statement of when to call it versus zcode_result or zcode_run_structured, and no exclusions or prerequisites.

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