Skip to main content
Glama
nexus-xyz

nexus-exchange-mcp

Official
by nexus-xyz

get_equity_history

Retrieve an authenticated account's equity time-series in 5-second intervals over about one hour, oldest first, with cursor pagination. Deprecated: use fetch_equity_history. Requires API credentials.

Instructions

Deprecated: use fetch_equity_history. Get the authenticated account's equity time-series (5s cadence, ~1h window), oldest first. For a longer window, or for PnL and volume series alongside equity, use fetch_portfolio_history. Returns { items, next_cursor }. items is this page of results; next_cursor is an opaque token for the next page, or null when this is the last page. To read the full history, keep calling with cursor: <previous next_cursor> until next_cursor is null. limit sets the size of ONE page, not a total. Requires API credentials.

Input Schema

TableJSON Schema
NameRequiredDescriptionDefault
limitNoMaximum number of points per page (max 720).
cursorNoOpaque pagination cursor. Omit for the first page; to get the next page, pass back the `next_cursor` from the previous response verbatim. Stop when `next_cursor` is null — that means there are no more results. Never construct or edit a cursor: the format is not part of the contract.

Schema Changelog

Changes observed during successful MCP inspections.

  1. Changed2 schema fields changedv0.2.0
    • addedInput schema / properties / cursor
      Added value: +{
      +  "description": "Opaque pagination cursor. Omit for the first page; to get the next page, pass back the `next_cursor` from the previous response verbatim. Stop when `next_cursor` is null — that means there are no more results. Never construct or edit a cursor: the format is not part of the contract.",
      +  "type": "string"
      +}
    • changedInput schema / properties / limit / description
      Previous value: -"Maximum number of points to return (max 720)."New value: +"Maximum number of points per page (max 720)."
  2. Added

TDQS

A4.5/5.0
Behavior4/5

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

No annotations exist, so the description carries the full burden and largely meets it: it discloses the auth requirement (API credentials), the pagination contract (cursor round-tripping until next_cursor is null), and the return shape. It stops short of stating read-only safety or rate-limit behavior, so it is strong but not exhaustive.

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?

Front-loads the critical deprecation notice, and the pagination prose earns its space since there is no output schema. Some of the cursor explanation duplicates the schema text, adding mild redundancy, but nothing is padding.

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?

For a deprecated, cursor-paginated read tool with no output schema, the description supplies the return shape, pagination loop, cadence, window, and auth requirement an agent needs. Only minor traits (rate limits, explicit read-only confirmation) are absent.

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 100%, so the schema already documents both params (baseline 3). The description adds genuine meaning: it clarifies that `limit` sizes ONE page rather than a total, and ties `cursor` to the previous response's `next_cursor` in the read-full-history loop.

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?

States a specific verb (get) and resource (equity time-series) plus its scope: 5s cadence, ~1h window, oldest-first ordering. It explicitly distinguishes itself from two siblings (`fetch_equity_history` as the replacement, `fetch_portfolio_history` for longer/PnL/volume windows).

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?

Opens with a deprecation directive naming the replacement tool, and names `fetch_portfolio_history` with the exact condition that selects it (longer window, or PnL/volume series). Both the when-to-use and when-to-use-something-else are explicit.

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

Deploy Server

Other Tools