Skip to main content
Glama
SidneyBissoli

Banco Central do Brasil (BCB) — SGS MCP

Comparar séries

bcb_comparar
Read-onlyIdempotent

Compare 2 to 5 economic time series over the same period and rank them by percentage variation, handling both level and variation series.

Instructions

Compara de 2 a 5 séries temporais no MESMO período (dataInicial e dataFinal obrigatórias), calculando a variação percentual de cada uma e ordenando-as num ranking (maior para menor variação). Série de nível entra pela variação entre as pontas; série que já é variação por período (IPCA, INPC, IGP-M mensais do catálogo; Selic/CDI acumulados no mês; poupança) entra pelo ACUMULADO encadeado do período — cada item diz em metodo qual conta foi feita, então "qual índice de preço subiu mais em 2024" é esta tool. Quando usar: para comparar/correlacionar a evolução de vários indicadores lado a lado. Quando NÃO usar: para uma única série use bcb_variacao. Retorna: periodo, totalSeries, seriesComDados, seriesComErro, ranking (cada item com posicao, codigo, nome, metodo, valorInicial, valorFinal, variacaoPercentual, maximo, minimo, media) e erros. Resiliente: séries sem dados no período, e séries de acumulado móvel (IPCA em 12 meses), são isoladas em erros sem invalidar a comparação. Periodicidades diferentes: comparar uma série diária com uma mensal alinha pontos que não são comparáveis, e a resposta avisa isso em aviso; informe frequencia (mensal|trimestral|anual) para harmonizar todas na mesma grade antes de comparar, escolhendo a convenção em agregacao. Janelas longas em séries diárias são fatiadas automaticamente (limite de 10 anos da API do BCB). Comportamento: consome a API pública SGS do Banco Central do Brasil — sem autenticação, chave de API ou cadastro, e sem limite de requisições divulgado (uso é best-effort). Em falha transitória ou timeout a chamada é repetida automaticamente (até 3 tentativas, backoff exponencial); persistindo o erro, retorna isError: true com mensagem em português (HTTP 404 = série inexistente ou sem dados no período solicitado). O resultado vem como JSON tanto em texto quanto em structuredContent (conforme o outputSchema); datas no formato dd/MM/yyyy e valores numéricos (ponto decimal).

Input Schema

TableJSON Schema
NameRequiredDescriptionDefault
codigosYesArray com 2 a 5 códigos de séries para comparar
agregacaoNoComo agregar os valores de cada período quando `frequencia` é informada. `ultimo` (padrão) serve a nível de preço, taxa e índice; `soma` a fluxo; `acumulada` a séries que JÁ SÃO variação percentual (IPCA mensal, por exemplo), compondo geometricamente — somar 12 variações mensais NÃO dá a inflação do ano.ultimo
dataFinalYesData final (yyyy-MM-dd ou dd/MM/yyyy)
frequenciaNoOpcional: reamostra a série para esta frequência antes de responder (só agrega para períodos MAIORES; pedir frequência mais fina que a da série é recusado). Útil para comparar séries de periodicidades diferentes.
dataInicialYesData inicial (yyyy-MM-dd ou dd/MM/yyyy)

Output Schema

TableJSON Schema
NameRequiredDescriptionDefault
avisoNoPresente quando as séries comparadas têm periodicidades diferentes e nenhuma harmonização foi pedida — os números do ranking, nesse caso, não são diretamente comparáveis entre si.
errosYesSéries que não retornaram dados, com o motivo
periodoYesJanela temporal comparada
rankingYesSéries ordenadas pela variação percentual (maior para menor)
derivacaoYesOrigem dos números calculados: o que é derivado, por qual motor e com quais convenções
provenanceYesBloco de proveniência (contrato v1.1): fonte, URL, competência, extração, diagnóstico de origem, citação e licença
attributionYesURLs canônicas das fontes desta resposta (lista de atribuição)
totalSeriesYesQuantidade de séries solicitadas
harmonizacaoNoPresente quando `frequencia` foi informada: descreve a reamostragem aplicada. Valor DERIVADO — calculado por este servidor, não publicado pelo Banco Central.
seriesComErroYesQuantidade de séries sem dados ou com erro
seriesComDadosYesQuantidade de séries com dados no período

Schema Changelog

Changes observed during successful MCP inspections.

  1. Changed8 schema fields changedv1.15.0
    • changedOutput schema / properties / provenance / 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 / properties / citation / description
      Previous value: -"Citação pronta para uso"New value: +"Citação/atribuição pronta para uso"
    • changedOutput schema / properties / provenance / 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 / 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 / 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 / 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 / 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 / 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. Changed5 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: +{
      +  "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"
      +}
    • addedOutput schema / properties / ranking / items / properties / metodo
      Added value: +{
      +  "description": "Como a variação foi medida: `nivel` = (último − primeiro) / primeiro, para série de nível; `encadeamento` = acumulado composto de todas as observações, para série que já é uma variação percentual por período (IPCA, INPC, IGP-M mensais e os núcleos/grupos do IPCA do catálogo; Selic e CDI acumulados no mês, 4390/4391; rentabilidade da poupança, 25/195 — nesta, uma observação por mês). A detecção cobre as séries de variação do catálogo curado; código fora dele é tratado como nível.",
      +  "enum": [
      +    "nivel",
      +    "encadeamento"
      +  ],
      +  "type": "string"
      +}
    • addedOutput schema / properties / ranking / items / properties / variacaoPercentual / description
      Added value: +"Variação entre as pontas (metodo nivel) ou acumulado encadeado do período (metodo encadeamento), em %"
    • changedOutput schema / required
      Previous value: -[
      -  "periodo",
      -  "totalSeries",
      -  "seriesComDados",
      -  "seriesComErro",
      -  "ranking",
      -  "erros",
      -  "derivacao"
      -]New value: +[
      +  "periodo",
      +  "totalSeries",
      +  "seriesComDados",
      +  "seriesComErro",
      +  "ranking",
      +  "erros",
      +  "derivacao",
      +  "provenance",
      +  "attribution"
      +]
  3. Changed9 schema fields changedv1.6.0
    • removedInput schema / $schema
      Removed value: -"http://json-schema.org/draft-07/schema#"
    • addedInput schema / properties / agregacao
      Added value: +{
      +  "default": "ultimo",
      +  "description": "Como agregar os valores de cada período quando `frequencia` é informada. `ultimo` (padrão) serve a nível de preço, taxa e índice; `soma` a fluxo; `acumulada` a séries que JÁ SÃO variação percentual (IPCA mensal, por exemplo), compondo geometricamente — somar 12 variações mensais NÃO dá a inflação do ano.",
      +  "enum": [
      +    "ultimo",
      +    "primeiro",
      +    "media",
      +    "soma",
      +    "acumulada"
      +  ],
      +  "type": "string"
      +}
    • addedInput schema / properties / frequencia
      Added value: +{
      +  "description": "Opcional: reamostra a série para esta frequência antes de responder (só agrega para períodos MAIORES; pedir frequência mais fina que a da série é recusado). Útil para comparar séries de periodicidades diferentes.",
      +  "enum": [
      +    "mensal",
      +    "trimestral",
      +    "anual"
      +  ],
      +  "type": "string"
      +}
    • removedOutput schema / $schema
      Removed value: -"http://json-schema.org/draft-07/schema#"
    • addedOutput schema / properties / aviso
      Added value: +{
      +  "description": "Presente quando as séries comparadas têm periodicidades diferentes e nenhuma harmonização foi pedida — os números do ranking, nesse caso, não são diretamente comparáveis entre si.",
      +  "type": "string"
      +}
    • addedOutput schema / properties / derivacao
      Added value: +{
      +  "additionalProperties": false,
      +  "description": "Origem dos números calculados: o que é derivado, por qual motor e com quais convenções",
      +  "properties": {
      +    "derived": {
      +      "description": "Sempre true: há número calculado nesta resposta",
      +      "type": "boolean"
      +    },
      +    "motor": {
      +      "description": "Componente que computou a estatística",
      +      "type": "string"
      +    },
      +    "nota": {
      +      "description": "Convenções de cálculo e arredondamento, em prosa",
      +      "type": "string"
      +    }
      +  },
      +  "required": [
      +    "derived",
      +    "motor",
      +    "nota"
      +  ],
      +  "type": "object"
      +}
    • addedOutput schema / properties / harmonizacao
      Added value: +{
      +  "additionalProperties": false,
      +  "description": "Presente quando `frequencia` foi informada: descreve a reamostragem aplicada. Valor DERIVADO — calculado por este servidor, não publicado pelo Banco Central.",
      +  "properties": {
      +    "agregacao": {
      +      "description": "Convenção usada para agregar os valores de cada período",
      +      "enum": [
      +        "ultimo",
      +        "primeiro",
      +        "media",
      +        "soma",
      +        "acumulada"
      +      ],
      +      "type": "string"
      +    },
      +    "derived": {
      +      "description": "Sempre true: o valor é derivado, não publicado pela fonte",
      +      "type": "boolean"
      +    },
      +    "frequencia": {
      +      "description": "Frequência de destino",
      +      "enum": [
      +        "mensal",
      +        "trimestral",
      +        "anual"
      +      ],
      +      "type": "string"
      +    },
      +    "nota": {
      +      "description": "Descrição em prosa do que foi calculado",
      +      "type": "string"
      +    },
      +    "observacoesOriginais": {
      +      "description": "Observações antes da agregação",
      +      "type": "number"
      +    }
      +  },
      +  "required": [
      +    "frequencia",
      +    "agregacao",
      +    "derived",
      +    "nota"
      +  ],
      +  "type": "object"
      +}
    • addedOutput schema / properties / ranking / items / properties / posicao / description
      Added value: +"Posição no ranking"
    • changedOutput schema / required
      Previous value: -[
      -  "periodo",
      -  "totalSeries",
      -  "seriesComDados",
      -  "seriesComErro",
      -  "ranking",
      -  "erros"
      -]New value: +[
      +  "periodo",
      +  "totalSeries",
      +  "seriesComDados",
      +  "seriesComErro",
      +  "ranking",
      +  "erros",
      +  "derivacao"
      +]
  4. Changed1 schema field changedv1.3.5
    • changedOutput schema / (root)
      Previous value: -nullNew value: +{
      +  "$schema": "http://json-schema.org/draft-07/schema#",
      +  "additionalProperties": false,
      +  "properties": {
      +    "erros": {
      +      "description": "Séries que não retornaram dados, com o motivo",
      +      "items": {
      +        "additionalProperties": false,
      +        "properties": {
      +          "codigo": {
      +            "type": "number"
      +          },
      +          "erro": {
      +            "type": "string"
      +          },
      +          "nome": {
      +            "type": "string"
      +          }
      +        },
      +        "required": [
      +          "codigo",
      +          "erro"
      +        ],
      +        "type": "object"
      +      },
      +      "type": "array"
      +    },
      +    "periodo": {
      +      "additionalProperties": false,
      +      "description": "Janela temporal comparada",
      +      "properties": {
      +        "dataFinal": {
      +          "type": "string"
      +        },
      +        "dataInicial": {
      +          "type": "string"
      +        }
      +      },
      +      "required": [
      +        "dataInicial",
      +        "dataFinal"
      +      ],
      +      "type": "object"
      +    },
      +    "ranking": {
      +      "description": "Séries ordenadas pela variação percentual (maior para menor)",
      +      "items": {
      +        "additionalProperties": false,
      +        "properties": {
      +          "categoria": {
      +            "type": "string"
      +          },
      +          "codigo": {
      +            "type": "number"
      +          },
      +          "maximo": {
      +            "type": "number"
      +          },
      +          "media": {
      +            "type": "number"
      +          },
      +          "minimo": {
      +            "type": "number"
      +          },
      +          "nome": {
      +            "type": "string"
      +          },
      +          "periodicidade": {
      +            "type": "string"
      +          },
      +          "posicao": {
      +            "type": "number"
      +          },
      +          "totalRegistros": {
      +            "type": "number"
      +          },
      +          "valorFinal": {
      +            "type": "number"
      +          },
      +          "valorInicial": {
      +            "type": "number"
      +          },
      +          "variacaoFormatada": {
      +            "type": "string"
      +          },
      +          "variacaoPercentual": {
      +            "type": "number"
      +          }
      +        },
      +        "required": [
      +          "posicao",
      +          "codigo",
      +          "nome"
      +        ],
      +        "type": "object"
      +      },
      +      "type": "array"
      +    },
      +    "seriesComDados": {
      +      "description": "Quantidade de séries com dados no período",
      +      "type": "number"
      +    },
      +    "seriesComErro": {
      +      "description": "Quantidade de séries sem dados ou com erro",
      +      "type": "number"
      +    },
      +    "totalSeries": {
      +      "description": "Quantidade de séries solicitadas",
      +      "type": "number"
      +    }
      +  },
      +  "required": [
      +    "periodo",
      +    "totalSeries",
      +    "seriesComDados",
      +    "seriesComErro",
      +    "ranking",
      +    "erros"
      +  ],
      +  "type": "object"
      +}
  5. First observedv1.0.0

TDQS

A4.6/5.0
Behavior4/5

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

Annotations already declare readOnlyHint=true, idempotentHint=true, destructiveHint=false. The description adds rich behavioral context: explains how the ranking is computed, how series without data are handled (isolated in `erros`), how different periodicities are aligned, and mentions automatic retry (up to 3 attempts), best-effort API usage, and error codes (HTTP 404). It even clarifies the meaning of `isError`. This goes beyond annotations, though it doesn't explicitly mention the retry behavior in annotations, but that's fine. No contradiction.

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 fairly long, but every sentence adds needed context. It front-loads the key purpose and usage guidance, then details behaviors and edge cases. It could be slightly more concise, but it is well-organized and not redundant. A 4 is justified.

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 complexity (mixed periodicities, error isolation, aggregation options, output schema with detailed ranking fields), the description covers all critical aspects: input validation, output structure, error handling, resilience, and the distinction from siblings. The output schema exists and covers return fields, so the description doesn't need to repeat them. This is a complete definition.

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

Parameters4/5

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

Schema description coverage is 100%, so all 5 parameters have descriptions in the schema. The description adds value by explaining the meaning of `agregacao` in detail (especially 'acumulada' and why summing monthly variations is wrong), and what `frequencia` does (only aggregates to larger periods, rejects finer frequencies). It also clarifies that `codigos` must be 2-5 and that `dataInicial`/`dataFinal` are required. The description enriches beyond the schema, e.g., explaining the impact of `frequencia` on alignment. Thus, a 4 is appropriate.

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 clearly states the tool compares 2-5 time series in the same period, calculates percentage variation, and ranks them. It distinguishes from bcb_variacao by explicitly stating when to use this tool vs. that one. The specific resource and action are unambiguous.

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?

The description provides explicit when-to-use ('para comparar/correlacionar a evolução de vários indicadores lado a lado') and when-not-to-use ('para uma única série use bcb_variacao'). It also explains how to handle mixed periodicities and aggregation, giving concrete guidance on the `frequencia` and `agregacao` parameters and their semantics.

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