Skip to main content
Glama

Describe an official dataset

describe_official_dataset
Read-onlyIdempotent

Get identity, publisher, collection, provenance links, query capability, and any stable Open Economics series shortcuts for an exact dataset ID returned by search_official_data. This does not fetch observations.

Input Schema

TableJSON Schema
NameRequiredDescriptionDefault
dataset_idYesExact ID returned by search_official_data, such as bcb-sgs:432, ibge-aggregates:5932, siconfi:dca, tesouro-rtn:government-central, tesouro-dpf:debt-profile, comexstat:general, anp:fuel-prices, epe:electricity-consumption, mte:formal-employment, or cvm:investment-funds.

Output Schema

TableJSON Schema
NameRequiredDescriptionDefault
idYesStable official dataset ID.
titleYesOfficial dataset title.
providerYesOpen Economics provider identifier.
sourceUrlYesOfficial source URL.
collectionNoOfficial collection identifier, when supplied by the publisher.
metadataUrlYesOfficial metadata URL.
sourceAgencyYesOfficial publishing agency.
collectionNameNoOfficial collection name, when supplied by the publisher.
queryCapabilityYesSupported query capability.

Schema Changelog

Changes observed during successful MCP inspections.

  1. Changed1 schema field changed
    • changedOutput schema / (root)
      Previous value: -nullNew value: +{
      +  "$schema": "https://json-schema.org/draft/2020-12/schema",
      +  "additionalProperties": {},
      +  "description": "Official dataset identity, source, provenance, and query capability.",
      +  "properties": {
      +    "collection": {
      +      "anyOf": [
      +        {
      +          "type": "string"
      +        },
      +        {
      +          "type": "null"
      +        }
      +      ],
      +      "description": "Official collection identifier, when supplied by the publisher."
      +    },
      +    "collectionName": {
      +      "anyOf": [
      +        {
      +          "type": "string"
      +        },
      +        {
      +          "type": "null"
      +        }
      +      ],
      +      "description": "Official collection name, when supplied by the publisher."
      +    },
      +    "id": {
      +      "description": "Stable official dataset ID.",
      +      "type": "string"
      +    },
      +    "metadataUrl": {
      +      "description": "Official metadata URL.",
      +      "type": "string"
      +    },
      +    "provider": {
      +      "description": "Open Economics provider identifier.",
      +      "type": "string"
      +    },
      +    "queryCapability": {
      +      "description": "Supported query capability.",
      +      "type": "string"
      +    },
      +    "sourceAgency": {
      +      "description": "Official publishing agency.",
      +      "type": "string"
      +    },
      +    "sourceUrl": {
      +      "description": "Official source URL.",
      +      "type": "string"
      +    },
      +    "title": {
      +      "description": "Official dataset title.",
      +      "type": "string"
      +    }
      +  },
      +  "required": [
      +    "id",
      +    "provider",
      +    "sourceAgency",
      +    "title",
      +    "sourceUrl",
      +    "metadataUrl",
      +    "queryCapability"
      +  ],
      +  "type": "object"
      +}
  2. First observed

TDQS

A4.3/5.0
Behavior4/5

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

Annotations already declare readOnly, idempotent, non-destructive, closed-world behavior, so the safety profile is covered. The description adds useful scope context beyond that: it enumerates the metadata categories returned and states the one thing the tool will not do (fetch observations).

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?

Two sentences, zero filler. The positive scope is front-loaded and the exclusionary clause comes last, which is the right ordering for routing.

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?

Return values are covered by the output schema, so the description need only state purpose and boundary. For a single-parameter, read-only lookup it does exactly that, leaving no gap an agent would need filled before calling it.

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% with a regex pattern and worked examples for dataset_id, so the schema carries the parameter burden. The description only restates that the value is an exact ID from search_official_data, adding no format or schema detail beyond it.

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?

Specific verb (get) plus resource (identity, publisher, collection, provenance, query capability, series shortcuts for a dataset ID) — an agent can see exactly what comes back. The closing sentence 'This does not fetch observations' cleanly separates it from the get_* siblings that return 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?

Explicitly ties the input to search_official_data ('an exact dataset ID returned by search_official_data') and rules out the data-fetching case. It stops short of naming which sibling to use instead for observations, but the implication (the get_* tools) is unambiguous.

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.