Skip to main content
Glama

Snapshot Registry

registry_snapshot
Read-onlyIdempotent

Read the registry summary: active objects and traits, loaded names, loader issues, etag and generatedAt. detail full includes definitions; names narrows them. includeInternal adds internal objects. Replies larger than 100,000 characters are refused with their size. object_registry reads one composed object; catalog_list reads components.

Input Schema

NameRequiredDescriptionDefault
namesNoExact trait and object names; misses go in notFound.
detailNosummary (default), or full definitions, best with names.summary
reproduceNoInclude the command and calls for reproducing this result.
includeInternalNoAlso list OODS Foundry's internal (non-business) objects, after the business objects. Without it they are left out and registry.hiddenInternal counts them.

Schema Changelog

Changes observed during successful MCP inspections.

  1. Changed4 schema fields changed
    • removedInput schema / $id
      Removed value: -"https://designlab.local/schemas/registry.snapshot.input.json"
    • removedInput schema / $schema
      Removed value: -"https://json-schema.org/draft/2020-12/schema"
    • addedInput schema / properties / reproduce
      Added value: +{
      +  "default": false,
      +  "description": "Include the command and calls for reproducing this result.",
      +  "type": "boolean"
      +}
    • changedInput schema / title
      Previous value: -"registry.snapshot input"New value: +"registry_snapshot input"
  2. Changed3 schema fields changed
    • changedInput schema / description
      Previous value: -"Bulk-read recorded mappings plus live shipped and registered team traits and objects. Reports definition loader issues, including shadowed names. Draft preferred_terms, disambiguation_decisions and capabilities are not snapshot outputs."New value: +"Bulk-read recorded mappings plus live shipped and registered team traits and objects. Reports definition loader issues, including shadowed names. The default summary leaves out each trait's and object's schema, parameters, view extensions, semantics, tokens and metadata; detail full returns them, optionally only for named traits and objects. Draft preferred_terms, disambiguation_decisions and capabilities are not snapshot outputs."
    • addedInput schema / properties / detail
      Added value: +{
      +  "default": "summary",
      +  "description": "summary (default), or full definitions, best with names.",
      +  "enum": [
      +    "summary",
      +    "full"
      +  ],
      +  "type": "string"
      +}
    • addedInput schema / properties / names
      Added value: +{
      +  "description": "Exact trait and object names; misses go in notFound.",
      +  "items": {
      +    "minLength": 1,
      +    "type": "string"
      +  },
      +  "minItems": 1,
      +  "type": "array",
      +  "uniqueItems": true
      +}
  3. First observed

TDQS

A4.6/5.0
Behavior5/5

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

Annotations already cover the safety profile (readOnly, idempotent, non-destructive, closed-world), so the description earns credit for the operational context they cannot carry: a hard 100,000-character response cap that refuses oversized replies and reports the size, plus loader-issue reporting including shadowed names. It also discloses what the default summary deliberately omits (schema, parameters, view extensions, semantics, tokens, metadata) and which draft fields are never snapshot outputs.

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 purpose, then progressively narrower conditionals and finally sibling routing; every sentence carries information with no filler. The telegraphic fragment style ("detail full includes definitions; names narrows them") is dense but occasionally clipped enough to require a second read.

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 output schema, the description carries the full burden of describing return values, and it does: the summary field list, the loader-issue report, the etag/generatedAt pair, the size-refusal response, and the hiddenInternal count. Combined with complete parameter documentation and sibling routing, an agent has everything needed to call it correctly.

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 description coverage is 100%, so the baseline is 3, but the description adds meaning beyond the schema: it explains that detail full returns definitions and is most useful combined with names, that names narrows the result set (with misses surfacing in notFound per the schema), and that includeInternal appends internal objects after business ones.

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 the registry summary") and enumerates what comes back: active objects and traits, loaded names, loader issues, etag and generatedAt. It explicitly differentiates from siblings by noting that object_registry reads one composed object and catalog_list reads components, so an agent can select it without opening a 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?

The closing sentence routes the agent to alternatives by describing what each sibling does (object_registry for a single composed object, catalog_list for components), which implies when not to use this tool. It also states the detail/names conditionals that select between summary and full output, though it never phrases an explicit "use X instead when..." exclusion.

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.