Secedgar Dataframe Describe
secedgar_dataframe_describeDescribe 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
| Name | Required | Description | Default |
|---|---|---|---|
| name | No | 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. |
Output Schema
| Name | Required | Description | Default |
|---|---|---|---|
| error | No | Present when the call failed. Absent on success. | |
| dataframes | No | Active dataframes for this tenant, newest first. Empty when none are registered. |