Skip to main content
Glama

Brapi Dataframe Describe

brapi_dataframe_describe
Read-onlyIdempotent

Start here after a spillover. Lists dataframes (or describes one) with columns, row counts, and originating-source provenance. The dataframe name appears inline on every find_* response that spilled (result.dataframe.tableName) — pass it as dataframe to inspect schema and provenance before writing the first brapi_dataframe_query. On a shared HTTP endpoint without per-caller auth, listing without a name is available only where each MCP session has its own workspace, and never to a request without a session; pass a known name instead.

Input Schema

NameRequiredDescriptionDefault
dataframeNoWhen set, return only the named dataframe. Omit to list all dataframes.

Output Schema

NameRequiredDescriptionDefault
errorNoPresent when the call failed. Absent on success.
tablesNoAll described dataframes.

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: `list_all_disabled_on_shared_http`: This server is running as a shared HTTP endpoint without per-caller auth — listing every dataframe would expose other concurrent clients' workspaces, since all callers resolve to one shared tenant. Other values are possible when a failure originates below the handler."New value: +"Machine-readable failure mode. Declared by this tool: `list_all_disabled_on_shared_http`: Listing was requested on a shared HTTP endpoint without per-caller auth, from a request with no session-scoped workspace — the listing would expose other clients' dataframes, since those requests all share one tenant workspace. Other values are possible when a failure originates below the handler."
  2. First observed

TDQS

A4.6/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 genuinely new behavioral context: a shared HTTP endpoint without per-caller auth only permits nameless listing where each MCP session owns a workspace, and never for a sessionless request. That access-control nuance is real value, though the sentence is dense enough to be hard to parse on first read.

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 action and the entry-point cue; every sentence carries information. The final sentence is overloaded with nested conditions (auth mode, workspace-per-session, no-session requests), which slightly hurts readability.

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 need no explanation here. The description covers the one parameter's origin, the ordering relative to brapi_dataframe_query, and the availability constraint — nothing an agent needs to invoke it correctly 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?

Schema coverage is 100% and the schema already documents omission-vs-set behavior, so the baseline is 3. The description goes further by explaining where the value comes from ('result.dataframe.tableName' on spilled find_* responses), which the schema cannot express.

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 ('Lists dataframes (or describes one)') plus exactly what it returns: columns, row counts, and originating-source provenance. It is clearly distinguishable from brapi_dataframe_query, which it names and positions itself ahead of.

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 explicit timing ('Start here after a spillover'), the trigger condition (a find_* response that spilled), and the sequencing rule ('inspect schema and provenance before writing the first brapi_dataframe_query'). It also states when listing without a name is unavailable and what to do instead (pass a known name).

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.