Skip to main content
Glama

Secedgar Dataframe Describe

secedgar_dataframe_describe
Read-onlyIdempotent

Describe the dataframes (df_XXXXX_XXXXX) registered by the data-returning secedgar_* tools — any tool whose response carries a dataset handle stages its full result set here. Pass that handle as name; each entry surfaces source tool, query parameters, creation/expiry timestamps, row count, column schema, and whether the dataframe is truncated relative to the upstream source. Without name it lists every active dataframe, except over HTTP with auth none, where every caller shares one canvas and that listing is refused. Read the column schema here before writing SQL for secedgar_dataframe_query.

Tool call template

This tool declares no required parameters. Add optional parameters from the input schema as needed.

{
  "id": 1,
  "jsonrpc": "2.0",
  "method": "tools/call",
  "params": {
    "arguments": {},
    "name": "secedgar_dataframe_describe"
  }
}

Input Schema

NameRequiredDescriptionDefault
nameNoTable name (df_XXXXX_XXXXX) to describe: the `dataset` name a data tool returned, or a register_as name. Omit it, or pass an empty string, to list every active dataframe; over HTTP with auth none that listing is refused.

Output Schema

NameRequiredDescriptionDefault
errorNoPresent when the call failed. Absent on success.
dataframesNoActive dataframes for this tenant, newest first. Empty when none are registered.

Schema Changelog

Changes observed during successful MCP inspections.

  1. Changed3 schema fields changed
    • changedInput schema / properties / name / description
      Previous value: -"Optional table name (df_XXXXX_XXXXX) to describe a single dataframe. Omit to list all dataframes."New value: +"Table name (df_XXXXX_XXXXX) to describe: the `dataset` name a data tool returned, or a register_as name. Omit it, or pass an empty string, to list every active dataframe; over HTTP with auth none that listing is refused."
    • changedOutput schema / properties / error / properties / data / properties / reason / description
      Previous value: -"Machine-readable failure mode. Declared by this tool: `canvas_unavailable`: The DataCanvas service is not configured for this deployment. Other values are possible when a failure originates below the handler."New value: +"Machine-readable failure mode. Declared by this tool: `canvas_unavailable`: The DataCanvas service is not configured for this deployment. `listing_unavailable`: name is omitted or empty over HTTP with auth none, where every caller shares one canvas. Other values are possible when a failure originates below the handler."
    • changedOutput schema / properties / error / properties / data / properties / reason / examples
      Previous value: -[
      -  "canvas_unavailable"
      -]New value: +[
      +  "canvas_unavailable",
      +  "listing_unavailable"
      +]
  2. Changed1 schema field changed
    • changedOutput schema / properties / dataframes / items / properties / expires_at / description
      Previous value: -"ISO 8601 expiry timestamp. Sliding TTL touched on every dataframe op."New value: +"ISO 8601 expiry timestamp, fixed when the table is staged; queries do not extend it."
  3. Changed1 schema field changed
    • changedOutput schema / properties / error / properties / data / properties / reason / description
      Previous value: -"Machine-readable failure mode. Declared by this tool: `canvas_unavailable`: The DataCanvas service is not configured for this deployment Other values are possible when a failure originates below the handler."New value: +"Machine-readable failure mode. Declared by this tool: `canvas_unavailable`: The DataCanvas service is not configured for this deployment. Other values are possible when a failure originates below the handler."
  4. Changed6 schema fields changed
    • changedInput schema / $schema
      Previous value: -"http://json-schema.org/draft-07/schema#"New value: +"https://json-schema.org/draft/2020-12/schema"
    • addedInput schema / additionalProperties
      Added value: +false
    • changedOutput schema / $schema
      Previous value: -"http://json-schema.org/draft-07/schema#"New value: +"https://json-schema.org/draft/2020-12/schema"
    • addedOutput schema / anyOf
      Added value: +[
      +  {
      +    "not": {
      +      "required": [
      +        "error"
      +      ]
      +    },
      +    "required": [
      +      "dataframes"
      +    ]
      +  },
      +  {
      +    "required": [
      +      "error"
      +    ]
      +  }
      +]
    • addedOutput schema / properties / error
      Added value: +{
      +  "additionalProperties": {},
      +  "description": "Present when the call failed. Absent on success.",
      +  "properties": {
      +    "code": {
      +      "description": "JSON-RPC error code for this failure.",
      +      "maximum": 9007199254740991,
      +      "minimum": -9007199254740991,
      +      "type": "integer"
      +    },
      +    "data": {
      +      "additionalProperties": {},
      +      "properties": {
      +        "reason": {
      +          "description": "Machine-readable failure mode. Declared by this tool: `canvas_unavailable`: The DataCanvas service is not configured for this deployment Other values are possible when a failure originates below the handler.",
      +          "examples": [
      +            "canvas_unavailable"
      +          ],
      +          "type": "string"
      +        },
      +        "recovery": {
      +          "additionalProperties": {},
      +          "description": "Actionable next step for the caller.",
      +          "properties": {
      +            "hint": {
      +              "type": "string"
      +            }
      +          },
      +          "required": [
      +            "hint"
      +          ],
      +          "type": "object"
      +        },
      +        "retryable": {
      +          "description": "Whether retrying may succeed.",
      +          "type": "boolean"
      +        }
      +      },
      +      "type": "object"
      +    },
      +    "message": {
      +      "description": "Human-readable description of what went wrong.",
      +      "type": "string"
      +    }
      +  },
      +  "required": [
      +    "code",
      +    "message"
      +  ],
      +  "type": "object"
      +}
    • removedOutput schema / required
      Removed value: -[
      -  "dataframes"
      -]
  5. Added

TDQS

A4.4/5.0
Behavior4/5

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

Annotations already cover read-only/idempotent/closed-world, but the description adds real behavior: the shared-canvas refusal under HTTP auth none, the truncation flag relative to the upstream source, and expiry timestamps. It stops short of saying what happens when a handle has expired or is unknown, which is the one behavioral gap.

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 what and the handle format, then the no-argument behavior and the query handoff. Dense and purposeful, with minor redundancy against the schema text on the `name` semantics.

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?

An output schema exists so return values needn't be enumerated, yet the description still names the practically important fields (row count, column schema, truncation, expiry) and warns about the shared-canvas edge case. Nothing an agent needs to call this correctly is missing.

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 schema's own `name` description already covers the df_ handle, the register_as name, and the empty-string/omit listing behavior, so the description largely restates it. It adds only the framing that the value comes from a data tool's `dataset` field.

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?

Specific verb+resource: 'Describe the dataframes (df_XXXXX_XXXXX)' and it explains provenance — staged by any secedgar_* tool whose response carries a `dataset` handle. That origin story plus the explicit handoff to secedgar_dataframe_query distinguishes it cleanly from the query sibling.

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 both modes of use (pass a handle to inspect one; omit `name` to list all), an explicit exclusion (listing refused over HTTP with auth none because callers share one canvas), and the downstream condition: read the column schema here before writing SQL for secedgar_dataframe_query.

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.