Skip to main content
Glama

BRAINIAC Equity Analytics

Build a dividend-reinvested total-return index

equity-analytics_total-return-series
Read-onlyIdempotent

Compound a total-return index from closes and cash dividends with optional withholding tax, and report price return, total return and CAGR. Price $0.03 USDC. POST /api/v1/equity-analytics/total-return-series. An unpaid call returns the x402 payment terms and does not run.

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": {
      "prices": "<prices>"
    },
    "name": "equity-analytics_total-return-series"
  }
}

Input Schema

NameRequiredDescriptionDefault
baseNobase, number. Required.
pricesYesprices, array. Required.
dividendsNodividends, array. Required.
withholdingTaxNowithholdingTax, number, from 0 to 1. Required.

Output Schema

NameRequiredDescriptionDefault
cagrNocagr. Number.
indexNoindex. Array.
sourcesNosources. Array.
limitationsNolimitations. Array.
priceReturnNopriceReturn. Number.
totalReturnNototalReturn. Number.

Schema Changelog

Changes observed during successful MCP inspections.

  1. First observed

TDQS

A3.6/5.0
Behavior4/5

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

Annotations already cover the safety profile: readOnlyHint, idempotentHint, destructiveHint false and openWorldHint true. The description adds meaningful context beyond that: the fixed price of $0.03 USDC, the concrete POST endpoint, and crucially that an unpaid call returns payment terms without executing. It does not describe edge cases like dividends falling on non-trading dates, so it is not a 5.

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?

Three tight sentences, with the computational purpose front-loaded ahead of pricing and endpoint details. Every sentence carries information an agent needs: what is computed, what it costs, and what happens if payment is absent. No filler or restated title text.

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 an output schema present, the description need not explain return values, and the rich annotations plus full schema coverage mean the description only has to add operational context, which it does via price and payment behavior. Remaining gaps are modest: dividend-date alignment rules and failure modes beyond non-payment are unstated. Adequate for a four-parameter computational tool.

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 percent, so every one of the four parameters is documented in the schema and the baseline is 3. The description corroborates the semantics by mentioning closes, cash dividends and optional withholding tax, mapping loosely onto prices, dividends and withholdingTax. It adds no format or constraint detail beyond what the schema already provides.

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 states a specific verb and resource: it compounds a total-return index from closes and cash dividends and reports price return, total return and CAGR. That is far more specific than the title alone and is distinguishable from siblings like corporate-action-adjust or dividend-metrics. It stops short of naming an alternative explicitly, so it sits at a strong 4 rather than a 5.

Agents choose between tools based on descriptions. A clear purpose with a specific verb and resource helps agents select the right tool.

Usage Guidelines2/5

Does the description explain when to use this tool, when not to, or what alternatives exist?

The description never states when to use this tool rather than a sibling such as corporate-action-adjust or dividend-metrics. The only conditional behavior it explains is payment gating: an unpaid call returns x402 payment terms and does not run. That is invocation mechanics, not when-to-use guidance, so the agent must infer applicability from the inputs.

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