Skip to main content
Glama

Guide to canonical schemas

guide_canonical_schema
Read-onlyIdempotent

Returns the exact machine schema for one canonical species: statement (default), the shape create_standard_statements accepts; chart, the shape create_standard_chart seals; or authorable declaration, the shape the declaration tools' document arm seals. For statement it is canonical JSON: one bare statement (schema, with each type's required controls, and an example), or several in the optional envelope (envelope_schema); topic csv adds how to build one from a CSV or bank export. Laws JSON Schema cannot express are listed in authoring_notes. Read-only, no workspace, and not metered.

Input Schema

NameRequiredDescriptionDefault
topicNoStatement only: csv adds how to build a canonical statement from a CSV or bank export, with two worked examples.
speciesNostatement (default) | chart | declaration
body_versionNoChart only: 4, the current body (default), or 3, the body of charts sealed before node namespaces.

Output Schema

NameRequiredDescriptionDefault
engineYes
schemaYes
statusYes
exampleNo
speciesYes
csv_guideNo
csv_examplesNo
schema_versionYes
authoring_notesYes
envelope_schemaNo

Schema Changelog

Changes observed during successful MCP inspections.

  1. First observed

TDQS

A4.2/5.0
Behavior4/5

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

Annotations already declare readOnly/idempotent/non-destructive/openWorld=false, and the description still adds real context: 'no workspace, and not metered,' plus what the payload contains (statement vs envelope_schema, authoring_notes for constraints JSON Schema cannot express). That is useful behavior beyond the annotation set.

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?

Purpose is front-loaded, but the body is a dense run-on with heavy jargon ('the shape the declaration tools' document arm seals') and drifts from the enum value 'declaration' to 'authorable declaration.' It is informative yet harder to parse than it needs to be.

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?

With an output schema present, return values need not be spelled out, yet the description still explains the two statement payload shapes and authoring_notes. Coverage is strong; only the naming mismatch on 'declaration' leaves a small ambiguity.

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 100% and all three params are enums, so the schema already carries most semantics; the description still adds the meaningful mapping from each species value to its consuming tool and flags 'statement' as the default. body_version is left to the schema, which is fine.

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 ('Returns the exact machine schema for one canonical species') and then disambiguates all three species by naming the sibling each shape serves (create_standard_statements, create_standard_chart, the declaration tools). An agent can tell exactly what it gets without opening the schema.

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?

Clear context for each mode: use 'statement' for the default statement shape, 'chart' for charts, 'declaration' for authorable declarations, plus 'topic csv' for CSV/bank-export construction. It does not say when NOT to use this versus guide_glossary or examples, so it stops short of explicit exclusions.

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