Skip to main content
Glama

nbb_describe

Read-onlyIdempotent

Returns an enriched fiche for an NBB dataflow, including populated dimension codes, multilingual names, frequencies, time coverage, and common queries; refresh against the live API when needed.

Instructions

Return the full enriched fiche for a dataflow (dimensions with the codes that actually hold data, multilingual names, frequencies, time coverage, common queries). Reads from the local catalogue by default; pass force_refresh=True to revalidate the structure against the live API.

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": {
      "dataflow_id": "<dataflow_id>"
    },
    "name": "nbb_describe"
  }
}

Input Schema

NameRequiredDescriptionDefault
agencyNoBE2
languageNoen
dataflow_idYes
force_refreshNo
include_codesNo

Output Schema

NameRequiredDescriptionDefault

No arguments

Schema Changelog

Changes observed during successful MCP inspections.

  1. First observedv0.2.0

TDQS

B3.4/5.0
Behavior4/5

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

Annotations already cover safety (readOnly, idempotent, closed-world), so the bar is lower, and the description still adds substantive behavior: a local catalogue cache with an explicit opt-in path to revalidate against the live API, plus the guarantee that returned codes are the ones that actually hold data. It does not mention staleness windows or cost/latency of force_refresh, which would be the remaining useful detail.

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?

Two sentences, front-loaded with the return value, and the parenthetical payload list is dense but each item is informative rather than filler. The cache/refresh sentence is placed correctly as a secondary operational note.

Shorter descriptions cost fewer tokens and are easier for agents to parse. Every sentence should earn its place.

Completeness3/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 structure needn't be restated, and the read-only nature is fully annotated. However, for a 5-parameter tool with zero schema descriptions, leaving four parameters unexplained makes the definition under-specified relative to its complexity.

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

Parameters2/5

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

Schema description coverage is 0%, so the description carries the full burden, yet it explains only force_refresh. agency (default BE2), language, and include_codes are left entirely undefined — an agent cannot tell whether agency selects a source database, filters results, or what include_codes does when set false, even though 'dimensions with the codes' hints at it.

Input schemas describe structure but not intent. Descriptions should explain non-obvious parameter relationships and valid value ranges.

Purpose4/5

Does the description clearly state what the tool does and how it differs from similar tools?

Names a specific verb (return) and resource (full enriched fiche for a dataflow) and enumerates the payload contents: dimensions with populated codes, multilingual names, frequencies, time coverage, common queries. That distinguishes it from nbb_query/nbb_compare, which operate on data rather than metadata, though the description never names a sibling explicitly.

Agents choose between tools based on descriptions. A clear purpose with a specific verb and resource helps agents select the right tool.

Usage Guidelines3/5

Does the description explain when to use this tool, when not to, or what alternatives exist?

Gives a clear operational default ('reads from the local catalogue by default; pass force_refresh=True to revalidate against the live API'), which is real guidance on how to call it. It never states when to prefer this over nbb_search or nbb_query, or what precondition (a known dataflow_id) is needed, so the when-to-use guidance is only implied.

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