Skip to main content
Glama

describe_relations

Read-only

What the schemas declare between types: references with form and cardinality, ownership, enums, joins, list kinds. Use for a diagram or audit; for one type's full schema use describe_schema. Optional type narrows every list, direction (declares, declared-to, both; needs type) one side of relations, via relations and enums. Returns those lists, with forms and reading explaining every term. Not paged.

Input Schema

TableJSON Schema
NameRequiredDescriptionDefault
viaNo
typeNo
directionNo

Output Schema

TableJSON Schema
NameRequiredDescriptionDefault
enumsYes
formsYes
joinsYes
listsYes
modelYes
readingYes
ownershipYes
relationsYes

Schema Changelog

Changes observed during successful MCP inspections.

  1. Changed4 schema fields changed
    • addedOutput schema / properties / relations / items / properties / by
      Added value: +{
      +  "type": [
      +    "string",
      +    "null"
      +  ]
      +}
    • addedOutput schema / properties / relations / items / properties / in
      Added value: +{
      +  "type": [
      +    "string",
      +    "null"
      +  ]
      +}
    • changedOutput schema / properties / relations / items / properties / to / type
      Previous value: -"string"New value: +[
      +  "string",
      +  "null"
      +]
    • changedOutput schema / properties / relations / items / required
      Previous value: -[
      -  "from",
      -  "via",
      -  "to",
      -  "form",
      -  "array",
      -  "required",
      -  "min",
      -  "max"
      -]New value: +[
      +  "from",
      +  "via",
      +  "to",
      +  "form",
      +  "by",
      +  "in",
      +  "array",
      +  "required",
      +  "min",
      +  "max"
      +]
  2. Changed12 schema fields changed
    • addedInput schema / properties / direction
      Added value: +{
      +  "enum": [
      +    "declares",
      +    "declared-to",
      +    "both"
      +  ],
      +  "type": "string"
      +}
    • addedInput schema / properties / type
      Added value: +{
      +  "type": "string"
      +}
    • addedInput schema / properties / via
      Added value: +{
      +  "type": "string"
      +}
    • changedOutput schema / additionalProperties
      Previous value: -{}New value: +false
    • addedOutput schema / properties / enums
      Added value: +{
      +  "items": {
      +    "additionalProperties": {},
      +    "properties": {
      +      "required": {
      +        "type": "boolean"
      +      },
      +      "tokens": {
      +        "items": {
      +          "type": "string"
      +        },
      +        "type": "array"
      +      },
      +      "type": {
      +        "type": "string"
      +      },
      +      "via": {
      +        "type": "string"
      +      }
      +    },
      +    "required": [
      +      "via",
      +      "tokens",
      +      "required",
      +      "type"
      +    ],
      +    "type": "object"
      +  },
      +  "type": "array"
      +}
    • addedOutput schema / properties / forms
      Added value: +{
      +  "additionalProperties": {
      +    "type": "string"
      +  },
      +  "propertyNames": {
      +    "type": "string"
      +  },
      +  "type": "object"
      +}
    • addedOutput schema / properties / joins
      Added value: +{
      +  "items": {
      +    "additionalProperties": {},
      +    "properties": {
      +      "kind": {
      +        "type": "string"
      +      },
      +      "section": {
      +        "type": "string"
      +      },
      +      "type": {
      +        "type": "string"
      +      }
      +    },
      +    "required": [
      +      "kind",
      +      "section",
      +      "type"
      +    ],
      +    "type": "object"
      +  },
      +  "type": "array"
      +}
    • addedOutput schema / properties / lists
      Added value: +{
      +  "items": {
      +    "additionalProperties": {},
      +    "properties": {
      +      "kind": {
      +        "type": "string"
      +      },
      +      "min": {
      +        "maximum": 9007199254740991,
      +        "minimum": 0,
      +        "type": "integer"
      +      },
      +      "required": {
      +        "type": "boolean"
      +      },
      +      "section": {
      +        "type": "string"
      +      },
      +      "type": {
      +        "type": "string"
      +      }
      +    },
      +    "required": [
      +      "section",
      +      "kind",
      +      "required",
      +      "min",
      +      "type"
      +    ],
      +    "type": "object"
      +  },
      +  "type": "array"
      +}
    • addedOutput schema / properties / ownership
      Added value: +{
      +  "items": {
      +    "additionalProperties": false,
      +    "properties": {
      +      "owned": {
      +        "type": "string"
      +      },
      +      "owner": {
      +        "type": "string"
      +      }
      +    },
      +    "required": [
      +      "owner",
      +      "owned"
      +    ],
      +    "type": "object"
      +  },
      +  "type": "array"
      +}
    • addedOutput schema / properties / reading
      Added value: +{
      +  "additionalProperties": {
      +    "type": "string"
      +  },
      +  "propertyNames": {
      +    "type": "string"
      +  },
      +  "type": "object"
      +}
    • addedOutput schema / properties / relations
      Added value: +{
      +  "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"
      +      },
      +      "to": {
      +        "type": "string"
      +      },
      +      "via": {
      +        "type": "string"
      +      }
      +    },
      +    "required": [
      +      "from",
      +      "via",
      +      "to",
      +      "form",
      +      "array",
      +      "required",
      +      "min",
      +      "max"
      +    ],
      +    "type": "object"
      +  },
      +  "type": "array"
      +}
    • changedOutput schema / required
      Previous value: -[
      -  "model"
      -]New value: +[
      +  "relations",
      +  "ownership",
      +  "enums",
      +  "joins",
      +  "lists",
      +  "forms",
      +  "reading",
      +  "model"
      +]
  3. First observed

TDQS

A4.5/5.0
Behavior4/5

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

Annotations already declare readOnlyHint and openWorldHint=false, so safety is covered. The description adds real behavioral context: the result is unpaged ('Not paged') and includes `forms` and `reading` fields that explain every term. It stops short of describing volume or shape of the returned lists.

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?

Very dense and front-loaded: purpose first, then routing, then parameter semantics, then return note. Every clause earns its place, though the telegraphic, comma-spliced style costs a little readability.

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 needn't be re-explained, yet the description still notes the lists, `forms`, and `reading`. Combined with clear param semantics and annotation-covered safety, an agent has what it needs, with only the value formats for `type`/`via` left implicit.

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 0%, so the description must carry the load, and it does: `type` narrows every list, `direction` gives one side of relations and needs `type`, `via` scopes relations and enums. It covers all three params meaningfully, though it doesn't state the accepted value format for `type` or `via`.

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?

Names the specific resource (relations declared between types) and enumerates what it covers: references with form/cardinality, ownership, enums, joins, list kinds. It explicitly distinguishes itself from the sibling describe_schema, so an agent can route without opening either 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?

States the use case ('for a diagram or audit') and names the alternative with its selecting condition ('for one type's full schema use describe_schema'). It also flags the dependency that `direction` requires `type`, which is usage guidance beyond the schema.

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