Skip to main content
Glama

Read Tool Schema

tool_schema
Read-onlyIdempotent

Read a shipped tool schema by name and kind (input or output). Returns its JSON Schema, package-relative file, recorded file hash and source URL. tools/list describes this endpoint’s narrower accepted inputs; the full schema may describe operations outside the hosted tools.

Input Schema

NameRequiredDescriptionDefault
kindNoThe tool's input schema or its output schema.input
nameYesAny OODS Foundry tool at this version, local-only tools included.
reproduceNoInclude the command and calls for reproducing this result.

Schema Changelog

Changes observed during successful MCP inspections.

  1. Changed1 schema field changed
    • changedInput schema / properties / name / enum
      Previous value: -[
      -  "tokens_build",
      -  "structured_data_fetch",
      -  "brand_apply",
      -  "brand_create",
      -  "catalog_list",
      -  "code_generate",
      -  "design_compose",
      -  "design_preview",
      -  "pipeline_run",
      -  "health_check",
      -  "registry_snapshot",
      -  "viz_render",
      -  "dashboard_render",
      -  "artifact_certify",
      -  "fidelity_preview",
      -  "component_map",
      -  "schema_store",
      -  "object_registry",
      -  "schema_render",
      -  "object_import",
      -  "a11y_scan"
      -]New value: +[
      +  "tokens_build",
      +  "structured_data_fetch",
      +  "brand_apply",
      +  "brand_create",
      +  "brand_read",
      +  "catalog_list",
      +  "code_generate",
      +  "design_compose",
      +  "design_preview",
      +  "design_versions",
      +  "pipeline_run",
      +  "health_check",
      +  "registry_snapshot",
      +  "viz_render",
      +  "dashboard_render",
      +  "artifact_certify",
      +  "fidelity_preview",
      +  "component_map",
      +  "component_map_read",
      +  "schema_store",
      +  "schema_read",
      +  "object_registry",
      +  "object_register",
      +  "schema_render",
      +  "object_import",
      +  "object_import_read",
      +  "a11y_scan"
      +]
  2. Changed1 schema field changed
    • addedInput schema / properties / reproduce
      Added value: +{
      +  "default": false,
      +  "description": "Include the command and calls for reproducing this result.",
      +  "type": "boolean"
      +}
  3. Changed2 schema fields changed
    • addedInput schema / properties / kind / description
      Added value: +"The tool's input schema or its output schema."
    • addedInput schema / properties / name / description
      Added value: +"Any OODS Foundry tool at this version, local-only tools included."
  4. Changed1 schema field changed
    • changedInput schema / properties / name / enum
      Previous value: -[
      -  "tokens_build",
      -  "structured_data_fetch",
      -  "brand_apply",
      -  "brand_create",
      -  "catalog_list",
      -  "code_generate",
      -  "design_compose",
      -  "design_preview",
      -  "pipeline_run",
      -  "health_check",
      -  "registry_snapshot",
      -  "viz_render",
      -  "dashboard_render",
      -  "artifact_certify",
      -  "fidelity_preview",
      -  "component_map",
      -  "schema_store",
      -  "object_registry",
      -  "schema_render",
      -  "a11y_scan"
      -]New value: +[
      +  "tokens_build",
      +  "structured_data_fetch",
      +  "brand_apply",
      +  "brand_create",
      +  "catalog_list",
      +  "code_generate",
      +  "design_compose",
      +  "design_preview",
      +  "pipeline_run",
      +  "health_check",
      +  "registry_snapshot",
      +  "viz_render",
      +  "dashboard_render",
      +  "artifact_certify",
      +  "fidelity_preview",
      +  "component_map",
      +  "schema_store",
      +  "object_registry",
      +  "schema_render",
      +  "object_import",
      +  "a11y_scan"
      +]
  5. Changed1 schema field changed
    • changedInput schema / properties / name / enum
      Previous value: -[
      -  "tokens_build",
      -  "structuredData_fetch",
      -  "brand_apply",
      -  "brand_intake",
      -  "catalog_list",
      -  "code_generate",
      -  "design_compose",
      -  "design_preview",
      -  "pipeline",
      -  "health",
      -  "registry_snapshot",
      -  "viz_render",
      -  "dashboard_render",
      -  "artifact_certify",
      -  "fidelity_preview",
      -  "map",
      -  "schema",
      -  "object",
      -  "repl",
      -  "a11y_scan"
      -]New value: +[
      +  "tokens_build",
      +  "structured_data_fetch",
      +  "brand_apply",
      +  "brand_create",
      +  "catalog_list",
      +  "code_generate",
      +  "design_compose",
      +  "design_preview",
      +  "pipeline_run",
      +  "health_check",
      +  "registry_snapshot",
      +  "viz_render",
      +  "dashboard_render",
      +  "artifact_certify",
      +  "fidelity_preview",
      +  "component_map",
      +  "schema_store",
      +  "object_registry",
      +  "schema_render",
      +  "a11y_scan"
      +]
  6. First observed

TDQS

A4/5.0
Behavior4/5

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

Annotations already declare readOnly, idempotent, non-destructive, closed-world, so the bar is low. The description nonetheless adds valuable behavioral context: what the return payload contains (JSON Schema, package-relative file, hash, source URL) and the caveat that the full schema may describe operations outside the hosted tools.

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?

Two tight sentences: the first declares purpose and return contents, the second is a scoping caveat. No filler, front-loaded, each sentence earns its place.

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?

No output schema exists, so the description rightly explains the return fields; annotations cover safety and idempotency. A minor gap is the absence of explicit routing to a sibling alternative, but for a simple three-param read tool this is otherwise complete.

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 coverage is 100% and both 'kind' and 'name' already carry descriptions in the schema, including the enum values. The description restates the name/kind pair but adds no syntax, defaults, or format detail beyond what the schema provides. Baseline 3 is correct.

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 (Read) and resource (shipped tool schema) with the discriminant (by name and kind) front-loaded. The mention of the 'kind' input/output split cleanly separates it from any sibling that reads other artifacts.

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?

Implies when to use via 'Read a shipped tool schema' and warns that tools/list describes this endpoint's narrower inputs, but never explicitly names an alternative tool or states when not to use this one. Usage is inferable, not spelled out.

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.