Skip to main content
Glama

describe_schema

Read-onlyIdempotent

Learn the canonical filing and document fields, types, categories, statuses, and graph edge kinds before filtering. Use it to avoid invalid interpretations without reading filings.

Instructions

Use this before filtering or interpreting results to learn the canonical fields.

Returns the filing and document field names with types, plus the known filing types, categories, document statuses, and graph edge kinds. Reads no filings.

Input Schema

TableJSON Schema
NameRequiredDescriptionDefault

No arguments

Output Schema

TableJSON Schema
NameRequiredDescriptionDefault
resultYes

Schema Changelog

Changes observed during successful MCP inspections.

  1. First observed

TDQS

A4.5/5.0
Behavior4/5

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

The annotations already mark this as read-only and idempotent. The description adds meaningful context beyond that: it explicitly says the tool 'reads no filings,' which reassures the agent that this is a metadata-only operation with no side effects. This is useful behavioral disclosure.

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?

The description is compact and front-loaded: the usage guidance is the first sentence, and the return contents are listed in the second. Every sentence earns its place with no fluff or repetition.

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?

For a zero-parameter introspection tool with a rich output schema, the description is fully complete. It tells the agent when to use it, what it returns, and that it has no data-reading side effects. Nothing necessary for correct invocation is missing.

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?

The tool has zero parameters, so the schema covers everything structurally. The baseline of 4 applies. The description adds no parameter details because none are needed.

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?

The description states a specific action ('describe schema') with a clear resource, and enumerates exactly what is returned: filing/document field names with types, known filing types, categories, document statuses, and graph edge kinds. It also distinguishes itself from sibling data-retrieval tools by noting it 'reads no filings.'

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 description gives explicit usage timing: use it 'before filtering or interpreting results to learn the canonical fields.' It does not explicitly name alternatives or when not to use it, but the guidance is clear enough for an agent to know this is the precondition step.

Agents often have multiple tools that could apply. Explicit usage guidance like "use X instead of Y when Z" prevents misuse.