Skip to main content
Glama

describe_schema

Read-only

One type's schema: its sections as written and its declared relations as data. Use to learn what an entity of the type may hold; for the whole vocabulary use describe_relations. Input: type. Returns url, the schema's own file, sections, and relations: owner, owns, references both ways, enums, joins and lists.

Input Schema

TableJSON Schema
NameRequiredDescriptionDefault
typeYesA type name from list_types, such as skill

Output Schema

TableJSON Schema
NameRequiredDescriptionDefault
urlYes
nameYes
typeYes
modelYes
taglineYes
sectionsYes
relationsYes

Schema Changelog

Changes observed during successful MCP inspections.

  1. Changed7 schema fields changed
    • addedOutput schema / properties / relations / properties / referencedBy / items / properties / by
      Added value: +{
      +  "type": [
      +    "string",
      +    "null"
      +  ]
      +}
    • addedOutput schema / properties / relations / properties / referencedBy / items / properties / in
      Added value: +{
      +  "type": [
      +    "string",
      +    "null"
      +  ]
      +}
    • changedOutput schema / properties / relations / properties / referencedBy / items / required
      Previous value: -[
      -  "from",
      -  "via",
      -  "form",
      -  "array",
      -  "required",
      -  "min",
      -  "max"
      -]New value: +[
      +  "from",
      +  "via",
      +  "form",
      +  "by",
      +  "in",
      +  "array",
      +  "required",
      +  "min",
      +  "max"
      +]
    • addedOutput schema / properties / relations / properties / references / items / properties / by
      Added value: +{
      +  "type": [
      +    "string",
      +    "null"
      +  ]
      +}
    • addedOutput schema / properties / relations / properties / references / items / properties / in
      Added value: +{
      +  "type": [
      +    "string",
      +    "null"
      +  ]
      +}
    • changedOutput schema / properties / relations / properties / references / items / properties / to / type
      Previous value: -"string"New value: +[
      +  "string",
      +  "null"
      +]
    • changedOutput schema / properties / relations / properties / references / items / required
      Previous value: -[
      -  "via",
      -  "to",
      -  "form",
      -  "array",
      -  "required",
      -  "min",
      -  "max"
      -]New value: +[
      +  "via",
      +  "to",
      +  "form",
      +  "by",
      +  "in",
      +  "array",
      +  "required",
      +  "min",
      +  "max"
      +]
  2. Changed2 schema fields changed
    • addedOutput schema / properties / url
      Added value: +{
      +  "type": [
      +    "string",
      +    "null"
      +  ]
      +}
    • changedOutput schema / required
      Previous value: -[
      -  "type",
      -  "name",
      -  "tagline",
      -  "sections",
      -  "relations",
      -  "model"
      -]New value: +[
      +  "type",
      +  "name",
      +  "tagline",
      +  "url",
      +  "sections",
      +  "relations",
      +  "model"
      +]
  3. Changed7 schema fields changed
    • changedOutput schema / additionalProperties
      Previous value: -{}New value: +false
    • addedOutput schema / properties / name
      Added value: +{
      +  "type": "string"
      +}
    • addedOutput schema / properties / relations
      Added value: +{
      +  "additionalProperties": false,
      +  "properties": {
      +    "enums": {
      +      "items": {
      +        "additionalProperties": {},
      +        "properties": {
      +          "required": {
      +            "type": "boolean"
      +          },
      +          "tokens": {
      +            "items": {
      +              "type": "string"
      +            },
      +            "type": "array"
      +          },
      +          "via": {
      +            "type": "string"
      +          }
      +        },
      +        "required": [
      +          "via",
      +          "tokens",
      +          "required"
      +        ],
      +        "type": "object"
      +      },
      +      "type": "array"
      +    },
      +    "joins": {
      +      "items": {
      +        "additionalProperties": {},
      +        "properties": {
      +          "kind": {
      +            "type": "string"
      +          },
      +          "section": {
      +            "type": "string"
      +          }
      +        },
      +        "required": [
      +          "kind",
      +          "section"
      +        ],
      +        "type": "object"
      +      },
      +      "type": "array"
      +    },
      +    "lists": {
      +      "items": {
      +        "additionalProperties": {},
      +        "properties": {
      +          "kind": {
      +            "type": "string"
      +          },
      +          "min": {
      +            "maximum": 9007199254740991,
      +            "minimum": 0,
      +            "type": "integer"
      +          },
      +          "required": {
      +            "type": "boolean"
      +          },
      +          "section": {
      +            "type": "string"
      +          }
      +        },
      +        "required": [
      +          "section",
      +          "kind",
      +          "required",
      +          "min"
      +        ],
      +        "type": "object"
      +      },
      +      "type": "array"
      +    },
      +    "owner": {
      +      "type": [
      +        "string",
      +        "null"
      +      ]
      +    },
      +    "owns": {
      +      "items": {
      +        "type": "string"
      +      },
      +      "type": "array"
      +    },
      +    "referencedBy": {
      +      "items": {
      +        "additionalProperties": false,
      +        "properties": {
      +          "array": {
      +            "type": "boolean"
      +          },
      +          "form": {
      +            "enum": [
      +              "ref",
      +              "ref?",
      +              "qualifier"
      +            ],
      +            "type": "string"
      +          },
      +          "from": {
      +            "type": "string"
      +          },
      +          "max": {
      +            "anyOf": [
      +              {
      +                "maximum": 9007199254740991,
      +                "minimum": 0,
      +                "type": "integer"
      +              },
      +              {
      +                "type": "null"
      +              }
      +            ]
      +          },
      +          "min": {
      +            "maximum": 9007199254740991,
      +            "minimum": 0,
      +            "type": "integer"
      +          },
      +          "required": {
      +            "type": "boolean"
      +          },
      +          "via": {
      +            "type": "string"
      +          }
      +        },
      +        "required": [
      +          "from",
      +          "via",
      +          "form",
      +          "array",
      +          "required",
      +          "min",
      +          "max"
      +        ],
      +        "type": "object"
      +      },
      +      "type": "array"
      +    },
      +    "references": {
      +      "items": {
      +        "additionalProperties": false,
      +        "properties": {
      +          "array": {
      +            "type": "boolean"
      +          },
      +          "form": {
      +            "enum": [
      +              "ref",
      +              "ref?",
      +              "qualifier"
      +            ],
      +            "type": "string"
      +          },
      +          "max": {
      +            "anyOf": [
      +              {
      +                "maximum": 9007199254740991,
      +                "minimum": 0,
      +                "type": "integer"
      +              },
      +              {
      +                "type": "null"
      +              }
      +            ]
      +          },
      +          "min": {
      +            "maximum": 9007199254740991,
      +            "minimum": 0,
      +            "type": "integer"
      +          },
      +          "required": {
      +            "type": "boolean"
      +          },
      +          "to": {
      +            "type": "string"
      +          },
      +          "via": {
      +            "type": "string"
      +          }
      +        },
      +        "required": [
      +          "via",
      +          "to",
      +          "form",
      +          "array",
      +          "required",
      +          "min",
      +          "max"
      +        ],
      +        "type": "object"
      +      },
      +      "type": "array"
      +    }
      +  },
      +  "required": [
      +    "owner",
      +    "owns",
      +    "references",
      +    "referencedBy",
      +    "enums",
      +    "joins",
      +    "lists"
      +  ],
      +  "type": "object"
      +}
    • addedOutput schema / properties / sections
      Added value: +{
      +  "items": {
      +    "additionalProperties": {},
      +    "properties": {
      +      "heading": {
      +        "type": "string"
      +      },
      +      "tables": {
      +        "items": {
      +          "additionalProperties": {},
      +          "properties": {
      +            "columns": {
      +              "items": {
      +                "type": "string"
      +              },
      +              "type": "array"
      +            },
      +            "rows": {
      +              "items": {
      +                "items": {
      +                  "type": "string"
      +                },
      +                "type": "array"
      +              },
      +              "type": "array"
      +            }
      +          },
      +          "required": [
      +            "columns",
      +            "rows"
      +          ],
      +          "type": "object"
      +        },
      +        "type": "array"
      +      },
      +      "text": {
      +        "type": "string"
      +      }
      +    },
      +    "required": [
      +      "heading",
      +      "text",
      +      "tables"
      +    ],
      +    "type": "object"
      +  },
      +  "type": "array"
      +}
    • addedOutput schema / properties / tagline
      Added value: +{
      +  "type": "string"
      +}
    • addedOutput schema / properties / type
      Added value: +{
      +  "type": "string"
      +}
    • changedOutput schema / required
      Previous value: -[
      -  "model"
      -]New value: +[
      +  "type",
      +  "name",
      +  "tagline",
      +  "sections",
      +  "relations",
      +  "model"
      +]
  4. First observed

TDQS

A3.6/5.0
Behavior3/5

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

Annotations already declare readOnlyHint=true and openWorldHint=false, so the safety profile is covered. The description adds mainly return-shape detail (url, sections, relations), which duplicates the output schema rather than disclosing new behavioral traits, so a baseline 3 is appropriate.

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?

Three compact sentences with purpose front-loaded, followed by when-to-use and input/return summary. Dense but every clause carries weight; only a minor lack of readability in the phrasing.

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?

An output schema exists so return values need not be explained, and the description still routes to describe_relations. Combined with full parameter coverage and read-only annotations, it is complete enough for an agent to call it correctly.

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 the single `type` parameter is already documented in the schema ('A type name from list_types, such as skill'). The description merely restates 'Input: `type`', adding no new syntax or format meaning, so the baseline 3 holds.

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?

States a specific verb+resource: it returns one type's schema, decomposed into 'sections as written' and 'declared relations as data'. It partially differentiates from siblings by naming describe_relations for the whole-vocabulary case, though the jargon ('sections as written') is slightly opaque.

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?

Explicitly states when to use it ('Use to learn what an entity of the type may hold') and names the alternative ('for the whole vocabulary use describe_relations'). No exclusions or prerequisites are given, but the routing guidance is clear.

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