Skip to main content
Glama

Oecd Dataframe Describe

oecd_dataframe_describe
Read-onlyIdempotent

List tables and columns staged on a DataCanvas by a prior oecd_query_dataset spill. Call this before oecd_dataframe_query to discover exact table and column names for SQL. Unavailable when the server runs with DataCanvas disabled.

Tool call template

Replace each placeholder with a value matching the input schema. Only required parameters are included; add optional parameters as needed.

{
  "id": 1,
  "jsonrpc": "2.0",
  "method": "tools/call",
  "params": {
    "arguments": {
      "canvas_id": "<canvas_id>"
    },
    "name": "oecd_dataframe_describe"
  }
}

Input Schema

NameRequiredDescriptionDefault
canvas_idYesCanvas ID returned by oecd_query_dataset — exactly 10 characters of letters, digits, hyphens, and underscores. Identifies the DataCanvas session holding the staged observation tables.

Output Schema

NameRequiredDescriptionDefault
errorNoPresent when the call failed. Absent on success.
tablesNoTables and views staged on this canvas.
canvas_idNoThe canvas ID whose tables are listed.
table_countNoTotal number of tables and views.

Schema Changelog

Changes observed during successful MCP inspections.

  1. Changed1 schema field changed
    • changedOutput schema / properties / error / properties / data / properties / reason / description
      Previous value: -"Machine-readable failure mode. Declared by this tool: `canvas_disabled`: DataCanvas is not configured — CANVAS_PROVIDER_TYPE is unset. `canvas_not_found`: The canvas_id has expired or was never created. Other values are possible when a failure originates below the handler."New value: +"Machine-readable failure mode. Declared by this tool: `canvas_disabled`: DataCanvas is not configured — CANVAS_PROVIDER_TYPE=none. `canvas_not_found`: The canvas_id has expired or was never created. Other values are possible when a failure originates below the handler."
  2. Changed2 schema fields changed
    • changedInput schema / properties / canvas_id / description
      Previous value: -"Canvas ID returned by oecd_query_dataset. Identifies the DataCanvas session holding the staged observation tables."New value: +"Canvas ID returned by oecd_query_dataset — exactly 10 characters of letters, digits, hyphens, and underscores. Identifies the DataCanvas session holding the staged observation tables."
    • addedInput schema / properties / canvas_id / pattern
      Added value: +"^[A-Za-z0-9_-]{10}$"
  3. First observed

TDQS

A4.4/5.0
Behavior4/5

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

Annotations already declare readOnlyHint, idempotentHint and openWorldHint=false, so the safety profile is covered. The description adds value beyond them by disclosing the preconditions for the data existing at all (it must have been staged by an earlier oecd_query_dataset call) and the deployment-level availability constraint (DataCanvas disabled). It does not describe the shape of the listing, but an output schema exists to carry that.

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?

Three short sentences, front-loaded with the purpose, followed by the call ordering and the availability caveat. No redundant restatement of the tool name or title.

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?

For a one-parameter, fully described, output-schema-backed discovery tool, the description covers provenance, ordering and availability. The one omission is failure behavior for an unknown or expired canvas_id, which is the most likely error mode and is neither in the description nor the schema.

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 canvas_id property already documents the 10-character pattern and that it comes from oecd_query_dataset. The description reinforces that provenance ("staged... by a prior oecd_query_dataset spill") but adds no format or validation detail beyond the schema, so the baseline 3 applies.

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?

States a specific verb and resource ("List tables and columns staged on a DataCanvas") plus the provenance of that data ("by a prior oecd_query_dataset spill"). An agent can immediately distinguish this discovery tool from oecd_dataframe_query and the dataset-metadata siblings.

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?

Gives an explicit ordering rule: "Call this before oecd_dataframe_query to discover exact table and column names for SQL." It also names a when-not condition: the tool is unavailable when the server runs with DataCanvas disabled. Both the trigger and the exclusion are stated outright.

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.