Skip to main content
Glama

Get REQ schema

get_req_schema

Retrieve the REQ domain's generated JSON Schema (2020-12) as raw text to discover constraints, answer structural questions, or resolve validation errors.

Instructions

Return the REQ domain's generated JSON Schema (2020-12 dialect) as raw text -- the machine-readable, parsed-JSON view of the document structure, not the markdown view (call get_req_template for the authoring starting point). Fetch it for constraint discovery, structural questions, or an unresolved validation error -- never as a mandatory pre-authoring fetch. Generated by specmgr schema and kept current by a pre-commit hook/CI step; includes a $comment schema-layout version marker for detecting a shape change without diffing the whole document.

Input Schema

NameRequiredDescriptionDefault

No arguments

Output Schema

NameRequiredDescriptionDefault
resultYes

Schema Changelog

Changes observed during successful MCP inspections.

  1. Addedv0.37.0

TDQS

A4.7/5.0
Behavior4/5

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

No annotations exist, so the description carries the full burden, and it discloses output format (raw text vs parsed/markdown), provenance (`specmgr schema` generation), freshness guarantees (pre-commit hook/CI keeps it current), and a `$comment` version marker for detecting shape changes. It stops short of stating that the call is a side-effect-free read and says nothing about failure modes when the schema file is missing.

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?

One front-loaded sentence establishes what is returned and what it is not; the second carries usage guidance; the third carries provenance and the version-marker detail. Every clause earns its place and there is no repetition of schema or title content.

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?

With no parameters and an output schema already present, the description only needs purpose, routing, and behavioral context — all three are supplied, including the staleness/version-marker mechanism an agent would otherwise not know about.

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?

Zero parameters, so there is nothing to disambiguate and the baseline of 4 applies. The description correctly spends no space restating an empty input schema.

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 ("Return the REQ domain's generated JSON Schema (2020-12 dialect) as raw text") and explicitly contrasts itself with the markdown view and with `get_req_template`. An agent can distinguish it from the sibling template/example/schema tools without opening any schema.

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

Usage Guidelines5/5

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

Names concrete triggers ("constraint discovery, structural questions, or an unresolved validation error") and an explicit exclusion ("never as a mandatory pre-authoring fetch"), plus the alternative to reach for instead. This is the when/when-not/alternative triad at full strength.

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

Deploy Server

Other Tools