Skip to main content
Glama
bcb-mcp
by msperlin

Describe Series

describe_series
Read-only

Retrieves metadata such as name, unit, frequency, source, description, and cache state for Brazilian Central Bank SGS series by numeric ID or alias.

Instructions

Show dictionary metadata (name, unit, frequency, source, description) and cache state.

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": {
      "series_ids": "<series_ids>"
    },
    "name": "describe_series"
  }
}

Input Schema

NameRequiredDescriptionDefault
series_idsYesSGS series identifiers. Each item may be a numeric SGS id (11) or a dictionary alias in English/Portuguese ('selic', 'ipca', 'desemprego', 'dolar'). Use search_series() when unsure.

Output Schema

NameRequiredDescriptionDefault

No arguments

Schema Changelog

Changes observed during successful MCP inspections.

  1. First observedv0.1.0

TDQS

A3.5/5.0
Behavior3/5

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

Annotations already declare readOnlyHint=true and openWorldHint=false, so the safety profile is covered. The description adds that cache state is included in the response, which is useful behavioral context, but says nothing about handling of unknown or mixed identifier types, partial failures, or the 50-item batch limit.

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?

A single front-loaded sentence that names the payload fields and the cache-state addition with zero filler. Nothing in it is redundant or misplaced.

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 and parameter documentation is complete, so the description need not explain return values in depth. Still, for a batch-capable lookup tool it omits what happens with invalid or unknown ids and how mixed id/alias inputs are resolved, which an agent would want to know before firing a 50-item request.

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%, and the schema already explains that items may be numeric SGS ids or English/Portuguese aliases and points to search_series. The description adds no meaning beyond that, so the baseline of 3 applies.

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?

The description gives a specific verb (show) and resource (dictionary metadata) and even enumerates the returned fields (name, unit, frequency, source, description) plus cache state. That is clear enough to know what the tool does, but it offers no contrast with siblings such as get_series, list_series, or search_series, leaving the agent to infer the boundary.

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?

The description itself contains no when-to-use or when-not-to-use guidance; usage is only implied by the word 'metadata'. The only routing hint lives in the schema ('Use search_series() when unsure'), which helps but is indirect and does not distinguish this from get_series or list_series.

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