Skip to main content
Glama
SidneyBissoli

Banco Central do Brasil (BCB) — SGS MCP

Buscar série no catálogo

bcb_buscar_serie
Read-onlyIdempotent

Search BCB time series by keyword or code in a curated catalog and the Open Data index to find series codes before querying their values.

Instructions

Busca séries do BCB por palavra-chave (ou pelo código) em DUAS camadas: o catálogo curado local de 135 séries verificadas contra a origem, que vem primeiro e com fonteNome dizendo se o nome é transcrito do portal do BCB ou herdado, e o índice do Portal de Dados Abertos do BCB, com milhares de séries identificadas por código. Ignora acentos e maiúsculas ('inflacao' encontra 'Inflação'); vários termos são combinados com E ('ipca servicos'). Quando usar: para descobrir o código de uma série antes de consultar valores. Quando NÃO usar: para navegar tudo por categoria use bcb_series_populares; para valores use bcb_serie_valores. Retorna: termo, totalEncontradas, series (cada item com codigo, nome, origem — 'curado' ou 'indice' — e, no índice, dataset com a página do portal), catalogo (origem, obtidoEm, seriesIndexadas, cobertura) e, quando aplicável, observacao, avisos, mensagem e sugestao. Cobertura: o índice NÃO é o SGS inteiro, portanto não encontrar aqui não prova que a série não exista — o campo catalogo.cobertura diz isso explicitamente em toda resposta. Comportamento de rede: o índice é servido de cache com validade de 24 h e a renovação é feita pela primeira busca após o vencimento (uma requisição ao portal, ~1 s); as demais buscas não tocam a rede. Se o portal estiver fora, a busca degrada para o catálogo curado (ou para o último índice obtido) e sinaliza em avisos, sempre com a data de obtenção visível.

Input Schema

TableJSON Schema
NameRequiredDescriptionDefault
termoYesTermo de busca (mínimo 2 caracteres) ou o código da série. Vários termos são combinados com E, sem distinção de acento; a palavra de todo dia é traduzida para a do BCB (déficit→resultado primário, calote→inadimplência, desemprego→desocupação) e a resposta diz quando isso aconteceu (notasVocabulario).
limiteNoMáximo de séries a devolver (1-100, padrão: 20). `totalEncontradas` traz o total antes do corte.

Output Schema

TableJSON Schema
NameRequiredDescriptionDefault
termoYesTermo pesquisado
avisosNoAvisos de degradação (índice vencido ou indisponível)
seriesYesSéries que correspondem ao termo — as do catálogo curado primeiro
catalogoYesProveniência do índice usado na busca
mensagemNoMensagem exibida quando nada é encontrado
sugestaoNoSugestões de termos alternativos
observacaoNoAviso de corte quando há mais resultados que `limite`
provenanceYesUm bloco por procedência que contribuiu com esta resposta (contrato v1.1; licenças nunca se fundem)
attributionYesURLs canônicas das fontes desta resposta (lista de atribuição)
notasVocabularioNoQuando um termo foi ampliado para a palavra que o BCB usa (déficit→resultado primário), diz qual
totalEncontradasYesQuantidade de séries encontradas, antes do corte por `limite`

Schema Changelog

Changes observed during successful MCP inspections.

  1. Changed9 schema fields changedv1.15.0
    • changedOutput schema / properties / provenance / description
      Previous value: -"Um bloco por procedência que contribuiu com esta resposta (contrato v1.0; licenças nunca se fundem)"New value: +"Um bloco por procedência que contribuiu com esta resposta (contrato v1.1; licenças nunca se fundem)"
    • changedOutput schema / properties / provenance / items / description
      Previous value: -"Bloco de proveniência (contrato v1.0): fonte, URL, competência, extração e licença"New value: +"Bloco de proveniência (contrato v1.1): fonte, URL, competência, extração, diagnóstico de origem, citação e licença"
    • changedOutput schema / properties / provenance / items / properties / citation / description
      Previous value: -"Citação pronta para uso"New value: +"Citação/atribuição pronta para uso"
    • changedOutput schema / properties / provenance / items / properties / data_vintage / description
      Previous value: -"Competência do dado segundo a fonte; null quando a fonte não expõe"New value: +"Competência/vintage do dado segundo a fonte; null quando a fonte não expõe"
    • changedOutput schema / properties / provenance / items / properties / license / description
      Previous value: -"Regime legal do dado"New value: +"Regime legal do dado (id SPDX quando há, senão o nome da licença)"
    • addedOutput schema / properties / provenance / items / properties / retrieval
      Added value: +{
      +  "description": "Diagnóstico de origem da chamada: como o dado foi obtido. Medição real do servidor; unstable=true pede ao agente que trate o dado como obtido com dificuldade; null quando o servidor não mede",
      +  "oneOf": [
      +    {
      +      "additionalProperties": false,
      +      "description": "Diagnóstico de origem da chamada: como o dado foi obtido. Medição real do servidor; unstable=true pede ao agente que trate o dado como obtido com dificuldade",
      +      "properties": {
      +        "anomalies": {
      +          "description": "Anomalias superadas até o sucesso, somadas por classe, em ordem fixa; [] se nenhuma",
      +          "items": {
      +            "additionalProperties": false,
      +            "properties": {
      +              "count": {
      +                "description": "Ocorrências desta classe na chamada",
      +                "minimum": 1,
      +                "type": "integer"
      +              },
      +              "kind": {
      +                "description": "Classe da anomalia (vocabulário fechado do contrato)",
      +                "enum": [
      +                  "timeout",
      +                  "network",
      +                  "http_4xx",
      +                  "http_5xx",
      +                  "rate_limited",
      +                  "malformed_body"
      +                ],
      +                "type": "string"
      +              }
      +            },
      +            "required": [
      +              "kind",
      +              "count"
      +            ],
      +            "type": "object"
      +          },
      +          "type": "array"
      +        },
      +        "attempts": {
      +          "description": "Tentativas somadas, incluindo as repetidas (>= requests)",
      +          "minimum": 1,
      +          "type": "integer"
      +        },
      +        "requests": {
      +          "description": "Idas distintas à origem que compõem esta resposta (fatias, páginas)",
      +          "minimum": 1,
      +          "type": "integer"
      +        },
      +        "unstable": {
      +          "description": "true se houve repetição (attempts > requests) ou alguma anomalia",
      +          "type": "boolean"
      +        }
      +      },
      +      "required": [
      +        "requests",
      +        "attempts",
      +        "anomalies",
      +        "unstable"
      +      ],
      +      "type": "object"
      +    },
      +    {
      +      "type": "null"
      +    }
      +  ]
      +}
    • changedOutput schema / properties / provenance / items / properties / retrieved_at / description
      Previous value: -"Instante REAL da extração na origem (ISO-8601, horário de Brasília). Resposta servida de cache mantém o instante do fetch ORIGINAL, que é a data de extração relevante."New value: +"Instante REAL da extração na origem (ISO-8601, fuso do servidor). Resposta servida de cache mantém o instante do fetch original, que é a data de extração relevante"
    • changedOutput schema / properties / provenance / items / properties / source_url / description
      Previous value: -"URL canônica que reproduz a consulta"New value: +"URL canônica que reproduz a consulta na fonte"
    • changedOutput schema / properties / provenance / items / required
      Previous value: -[
      -  "source",
      -  "source_url",
      -  "data_vintage",
      -  "retrieved_at",
      -  "citation",
      -  "license"
      -]New value: +[
      +  "source",
      +  "source_url",
      +  "data_vintage",
      +  "retrieved_at",
      +  "retrieval",
      +  "citation",
      +  "license"
      +]
  2. Changed2 schema fields changedv1.12.1
    • changedInput schema / properties / termo / description
      Previous value: -"Termo de busca (mínimo 2 caracteres) ou o código da série. Vários termos são combinados com E."New value: +"Termo de busca (mínimo 2 caracteres) ou o código da série. Vários termos são combinados com E, sem distinção de acento; a palavra de todo dia é traduzida para a do BCB (déficit→resultado primário, calote→inadimplência, desemprego→desocupação) e a resposta diz quando isso aconteceu (notasVocabulario)."
    • addedOutput schema / properties / notasVocabulario
      Added value: +{
      +  "description": "Quando um termo foi ampliado para a palavra que o BCB usa (déficit→resultado primário), diz qual",
      +  "items": {
      +    "type": "string"
      +  },
      +  "type": "array"
      +}
  3. Changed4 schema fields changedv1.9.2
    • addedOutput schema / properties / attribution
      Added value: +{
      +  "description": "URLs canônicas das fontes desta resposta (lista de atribuição)",
      +  "items": {
      +    "type": "string"
      +  },
      +  "type": "array"
      +}
    • addedOutput schema / properties / provenance
      Added value: +{
      +  "description": "Um bloco por procedência que contribuiu com esta resposta (contrato v1.0; licenças nunca se fundem)",
      +  "items": {
      +    "additionalProperties": false,
      +    "description": "Bloco de proveniência (contrato v1.0): fonte, URL, competência, extração e licença",
      +    "properties": {
      +      "citation": {
      +        "description": "Citação pronta para uso",
      +        "type": "string"
      +      },
      +      "data_vintage": {
      +        "description": "Competência do dado segundo a fonte; null quando a fonte não expõe",
      +        "type": [
      +          "string",
      +          "null"
      +        ]
      +      },
      +      "license": {
      +        "description": "Regime legal do dado",
      +        "type": [
      +          "string",
      +          "null"
      +        ]
      +      },
      +      "retrieved_at": {
      +        "description": "Instante REAL da extração na origem (ISO-8601, horário de Brasília). Resposta servida de cache mantém o instante do fetch ORIGINAL, que é a data de extração relevante.",
      +        "type": "string"
      +      },
      +      "source": {
      +        "description": "Fonte oficial do dado",
      +        "type": "string"
      +      },
      +      "source_url": {
      +        "description": "URL canônica que reproduz a consulta",
      +        "type": "string"
      +      }
      +    },
      +    "required": [
      +      "source",
      +      "source_url",
      +      "data_vintage",
      +      "retrieved_at",
      +      "citation",
      +      "license"
      +    ],
      +    "type": "object"
      +  },
      +  "type": "array"
      +}
    • addedOutput schema / properties / series / items / properties / fonteNome
      Added value: +{
      +  "description": "Só quando `origem` = curado. 'portal' = nome transcrito do dataset da série no Portal de Dados Abertos do BCB; 'medido' = série sem dataset no portal, nome herdado e apenas periodicidade e ordem de grandeza verificadas contra a origem.",
      +  "enum": [
      +    "portal",
      +    "medido"
      +  ],
      +  "type": "string"
      +}
    • changedOutput schema / required
      Previous value: -[
      -  "termo",
      -  "totalEncontradas",
      -  "series",
      -  "catalogo"
      -]New value: +[
      +  "termo",
      +  "totalEncontradas",
      +  "series",
      +  "catalogo",
      +  "provenance",
      +  "attribution"
      +]
  4. Changed16 schema fields changedv1.6.0
    • removedInput schema / $schema
      Removed value: -"http://json-schema.org/draft-07/schema#"
    • addedInput schema / properties / limite
      Added value: +{
      +  "default": 20,
      +  "description": "Máximo de séries a devolver (1-100, padrão: 20). `totalEncontradas` traz o total antes do corte.",
      +  "maximum": 100,
      +  "minimum": 1,
      +  "type": "number"
      +}
    • changedInput schema / properties / termo / description
      Previous value: -"Termo de busca (mínimo 2 caracteres)"New value: +"Termo de busca (mínimo 2 caracteres) ou o código da série. Vários termos são combinados com E."
    • removedOutput schema / $schema
      Removed value: -"http://json-schema.org/draft-07/schema#"
    • addedOutput schema / properties / avisos
      Added value: +{
      +  "description": "Avisos de degradação (índice vencido ou indisponível)",
      +  "items": {
      +    "type": "string"
      +  },
      +  "type": "array"
      +}
    • addedOutput schema / properties / catalogo
      Added value: +{
      +  "additionalProperties": false,
      +  "description": "Proveniência do índice usado na busca",
      +  "properties": {
      +    "cobertura": {
      +      "description": "Limite explícito de cobertura do índice",
      +      "type": "string"
      +    },
      +    "obtidoEm": {
      +      "description": "Timestamp ISO 8601 em que o índice do portal foi obtido",
      +      "type": "string"
      +    },
      +    "origem": {
      +      "description": "Camadas consultadas",
      +      "type": "string"
      +    },
      +    "seriesIndexadas": {
      +      "description": "Quantidade de séries no índice consultado",
      +      "type": "number"
      +    }
      +  },
      +  "required": [
      +    "origem",
      +    "seriesIndexadas",
      +    "cobertura"
      +  ],
      +  "type": "object"
      +}
    • addedOutput schema / properties / observacao
      Added value: +{
      +  "description": "Aviso de corte quando há mais resultados que `limite`",
      +  "type": "string"
      +}
    • changedOutput schema / properties / series / description
      Previous value: -"Séries que correspondem ao termo"New value: +"Séries que correspondem ao termo — as do catálogo curado primeiro"
    • changedOutput schema / properties / series / items / properties / categoria / description
      Previous value: -"Categoria econômica"New value: +"Categoria econômica (só no catálogo curado)"
    • addedOutput schema / properties / series / items / properties / dataset
      Added value: +{
      +  "description": "Página do dataset no portal de dados abertos (só quando `origem` = indice)",
      +  "type": "string"
      +}
    • changedOutput schema / properties / series / items / properties / nome / description
      Previous value: -"Nome da série"New value: +"Nome da série (revisado quando `origem` = curado; derivado do slug do portal quando = indice)"
    • addedOutput schema / properties / series / items / properties / origem
      Added value: +{
      +  "description": "Camada de onde veio o achado",
      +  "enum": [
      +    "curado",
      +    "indice"
      +  ],
      +  "type": "string"
      +}
    • changedOutput schema / properties / series / items / properties / periodicidade / description
      Previous value: -"Periodicidade da série"New value: +"Periodicidade (só no catálogo curado)"
    • changedOutput schema / properties / series / items / required
      Previous value: -[
      -  "codigo",
      -  "nome"
      -]New value: +[
      +  "codigo",
      +  "nome",
      +  "origem"
      +]
    • changedOutput schema / properties / totalEncontradas / description
      Previous value: -"Quantidade de séries encontradas"New value: +"Quantidade de séries encontradas, antes do corte por `limite`"
    • changedOutput schema / required
      Previous value: -[
      -  "termo",
      -  "totalEncontradas",
      -  "series"
      -]New value: +[
      +  "termo",
      +  "totalEncontradas",
      +  "series",
      +  "catalogo"
      +]
  5. Changed1 schema field changedv1.3.5
    • changedOutput schema / (root)
      Previous value: -nullNew value: +{
      +  "$schema": "http://json-schema.org/draft-07/schema#",
      +  "additionalProperties": false,
      +  "properties": {
      +    "mensagem": {
      +      "description": "Mensagem exibida quando nada é encontrado",
      +      "type": "string"
      +    },
      +    "series": {
      +      "description": "Séries que correspondem ao termo",
      +      "items": {
      +        "additionalProperties": false,
      +        "properties": {
      +          "categoria": {
      +            "description": "Categoria econômica",
      +            "type": "string"
      +          },
      +          "codigo": {
      +            "description": "Código da série no SGS/BCB",
      +            "type": "number"
      +          },
      +          "nome": {
      +            "description": "Nome da série",
      +            "type": "string"
      +          },
      +          "periodicidade": {
      +            "description": "Periodicidade da série",
      +            "type": "string"
      +          }
      +        },
      +        "required": [
      +          "codigo",
      +          "nome"
      +        ],
      +        "type": "object"
      +      },
      +      "type": "array"
      +    },
      +    "sugestao": {
      +      "description": "Sugestões de termos alternativos",
      +      "type": "string"
      +    },
      +    "termo": {
      +      "description": "Termo pesquisado",
      +      "type": "string"
      +    },
      +    "totalEncontradas": {
      +      "description": "Quantidade de séries encontradas",
      +      "type": "number"
      +    }
      +  },
      +  "required": [
      +    "termo",
      +    "totalEncontradas",
      +    "series"
      +  ],
      +  "type": "object"
      +}
  6. First observedv1.0.0

TDQS

A5/5.0
Behavior5/5

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

Annotations already declare readOnly/openWorld/idempotent hints, but the description goes far beyond them: it discloses accent/case-insensitive matching, AND-combination of terms, vocabulary translation, 24-hour cache behavior, network degradation to the curated catalog, and warning signals. This is rich behavioral context that annotations alone could not convey.

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?

Although long, the description is well-structured with clear labeled sections (Quando usar, Quando NÃO usar, Retorna, Cobertura, Comportamento de rede). The most important purpose and usage guidance are front-loaded, and every section adds operational value rather than repeating 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?

For a search tool with two data sources, cache behavior, degradation paths, and vocabulary nuances, the description covers all operational aspects an agent needs: return shape, coverage caveats, network behavior, and failure signaling. The sibling list and output schema further complete the picture, but the description itself is already self-sufficient.

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 coverage is 100%, yet the description still adds substantial meaning: it explains that 'termo' can be a code or keyword, that multiple terms are AND-combined, that accents are ignored, and that everyday words are translated to BCB vocabulary. The 'limite' parameter's truncation behavior is also clarified via 'totalEncontradas'.

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 a specific action ('Busca séries do BCB por palavra-chave ou pelo código') and immediately distinguishes this tool from siblings by naming bcb_series_populares and bcb_serie_valores as alternatives for other intents. The two-layer catalog/index behavior makes the tool's unique role unmistakable.

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?

It explicitly states when to use the tool ('para descobrir o código de uma série antes de consultar valores') and when not to use it, naming the exact alternative tools for category browsing and value retrieval. It also warns about coverage limitations, so an agent knows not to over-trust a negative result.

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