Skip to main content
Glama

search_dataflows

Find SDMX dataflows matching a topic or keyword. Retrieve a list of relevant datasets with refs you can pass to the next tool.

Instructions

Find dataflows (datasets) matching a topic.

Issues exactly one request to the service and matches the terms locally, so searching for synonyms costs nothing extra: put them all in one query rather than calling this repeatedly.

Returns: Matching dataflows, each with a ref to pass to the next tool.

Raises: ToolError: If the service is unknown or the request fails. The message carries a [kind] discriminator and a retry hint.

Input Schema

TableJSON Schema
NameRequiredDescriptionDefault
limitNoMaximum dataflows to return.
queryNoTopic to search for, such as 'banking' or 'policy rates'. Space-separated words are treated as alternatives and matched case-insensitively against each dataflow's id, name and description. Pass an empty string to list every dataflow.
serviceNoService name from list_services, or an SDMX-REST v2 base URL. Defaults to the pysdmx endpoint.

Output Schema

TableJSON Schema
NameRequiredDescriptionDefault
serviceYes
dataflowsYes
next_stepYes
match_countYes
search_termsYes
total_dataflows_on_serviceYes

Schema Changelog

Changes observed during successful MCP inspections.

  1. First observedv0.1.0

TDQS

A4.3/5.0
Behavior4/5

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

With no annotations, the description carries the full burden. It discloses that exactly one request is issued, terms are matched locally, and errors raise ToolError with a [kind] discriminator and retry hint. This goes beyond typical descriptions, though it stops short of covering side effects or permissions—less critical for a read-only search.

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?

The description is compact and well-structured, front-loading the purpose, then behavioral notes, then Returns and Raises sections. Every sentence adds value: the request-count note, the synonym advice, the ref routing hint, and the error format are all useful and not redundant with the schema.

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?

Given the tool's relative simplicity, full schema coverage, and the existence of an output schema, the description covers purpose, usage, behavior, return value routing, and error handling. No critical information 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.

Parameters3/5

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

Schema description coverage is 100%, so the schema already documents all three parameters thoroughly. The description adds no additional parameter-level detail, but the baseline of 3 applies since the schema does the heavy lifting.

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?

The description opens with 'Find dataflows (datasets) matching a topic', which names a specific verb and resource. It is clearly distinct from siblings: search_dataflows searches for dataflows, list_services lists services, inspect_dataflow inspects a single dataflow, and get_data fetches data.

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?

The description explains when to use the tool (topic search) and gives efficiency guidance: put synonyms in one query because matching is local. It does not explicitly name alternatives or say when not to use it, but the purpose is clear and the returned refs point to the next tool, providing contextual routing.

Agents often have multiple tools that could apply. Explicit usage guidance like "use X instead of Y when Z" prevents misuse.