Skip to main content
Glama

Inspect dataflow structure

inspect
Read-onlyIdempotent

Inspect a dataflow's dimensional structure and constraint codes.

Call as: inspect(agency_id="ABS", dataflow_id="ERP_Q")

Returns a brief summary for the user plus full dimensional detail (dimensions, code counts, sample code values with names, constraint type) for the assistant to reason over. Use this to drill into a dataflow found via discover before building a query with ask.

Args: agency_id: SDMX agency code, e.g. "ABS", "ESTAT", "OECD" dataflow_id: SDMX dataflow identifier, e.g. "ERP_Q", "DS-018995" (NOT dataset_id) sample: Max codes to show per dimension (default 10) debug: Append a per-stage telemetry breakdown (assistant-only) to the output (only populated when GSDMX2_MCP_TELEMETRY is enabled).

Input Schema

TableJSON Schema
NameRequiredDescriptionDefault
debugNo
sampleNo
agency_idYes
dataflow_idYes

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?

Annotations already declare readOnlyHint=true and idempotentHint=true, so safety is covered. The description adds return-structure detail (brief user summary vs. full assistant detail), debug telemetry behavior, and the constraint that dataflow_id is not a dataset_id. These go beyond the annotations and help the agent understand output handling and debugging.

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?

The description is front-loaded with the one-sentence purpose and call example, then return info, usage guidance, and a structured args block. It is slightly verbose for the args section, but the format is clear and each sentence earns its place.

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 an inspection tool with no output schema, the description fully explains the return value (summary plus full detail), all parameters, usage context relative to sibling tools, and the debug telemetry behavior. Nothing an agent needs to call it correctly is missing.

Complex tools with many parameters or behaviors need more documentation. Simple tools need less. This dimension scales expectations accordingly.

Parameters5/5

Does the description clarify parameter syntax, constraints, interactions, or defaults beyond what the schema provides?

Schema description coverage is 0%, so the description must fully document all four parameters. It does: agency_id and dataflow_id get examples and clarify the dataflow_id vs. dataset_id distinction; sample explains its role; debug explains when it is populated. This completely compensates for the absent schema descriptions.

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 ('inspect') and resource ('dataflow's dimensional structure and constraint codes'), clearly distinguishing it from siblings like inspect_dataset (which targets datasets) and discover (which finds dataflows). The call example further cements the intended target.

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?

Explicitly places the tool in a workflow: 'drill into a dataflow found via discover before building a query with ask.' This clarifies when to use it relative to discover and ask, and differentiates from inspect_dataset by noting the dataflow_id is not a dataset_id. It does not list explicit when-not-to-use scenarios for all siblings, but the context is strong.

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.

Resources