Skip to main content
Glama

OBM - Open Brazil Market

Quanto rendeu

obm_get_returns
Read-onlyIdempotent

Retorno total de ação por período, ou retornos mensais de fundo, em 1, 3, 5 anos ou máximo. Padrão: 1 ano.

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": {
      "asset_type": "<asset_type>",
      "identifier": "<identifier>"
    },
    "name": "obm_get_returns"
  }
}

Input Schema

NameRequiredDescriptionDefault
periodNoJanela: ações usam o retorno total do período; fundos, os retornos mensais dos últimos N anos.1y
asset_typeYes
identifierYesTicker, código de índice ou CNPJ de 14 dígitos (fundos), como na API.

Output Schema

NameRequiredDescriptionDefault
dataYes
metaYes
sourceYes
reference_dateYes

Schema Changelog

Changes observed during successful MCP inspections.

  1. First observed

TDQS

A3.8/5.0
Behavior4/5

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

Annotations already cover the safety profile (readOnly, idempotent, non-destructive, closed-world), so the description earns credit for the extra dimension it supplies: returns are reported as total return over the window for equities but as monthly return series for funds, plus the one-year default. It does not discuss response shape, but an output schema exists, so that is acceptable.

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 short clauses with the core distinction front-loaded and the default appended last, with no redundant wording. Density is high, though the phrasing compresses the equity/fund distinction enough that one read may not suffice for a non-Portuguese reader.

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

Completeness4/5

Given the tool's complexity, does the description cover enough for an agent to succeed on first attempt?

With three parameters, an output schema, and full annotation coverage, the description carries what it needs to: what the return series means, which asset types are supported, and the default window. The only gap is routing relative to sibling tools, which the description never addresses.

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 coverage is 67%, and asset_type has no schema description at all, so the description pays its debt by explaining what each enum value means ('ação' versus 'fundo') and by restating the period default in plain text. It adds real meaning over the enum lists, though it leaves identifier (ticker, index code, or CNPJ) entirely to the schema.

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 names a specific verb and resource ('Retorno total de ação por período, ou retornos mensais de fundo') and disambiguates the two asset-type behaviors in a single clause. It is clear what data comes back, but it makes no reference to sibling tools such as obm_get_price_history, so the agent must infer the boundary itself.

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?

It supplies the context of use (total return for equities, monthly returns for funds) and notes the default period of one year, which implicitly tells the agent the tool is for return series. However, it has no 'when to use this instead of X' rule and no exclusion, leaving the price-history and asset-listing siblings undifferentiated.

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.

Resources