Skip to main content
Glama

Hyperliquid Vault

hl_vault
Read-onlyIdempotent

One Hyperliquid vault by address, by view. profile: TVL, APR, leverage, leader and top-5 shares, active depositors and all five windows (7d, 30d, 90d, 365d, all). depositors: every current depositor (not only the largest 100) with equity, PnL on the current position, all-time PnL, entry time, lockup end and PnL rank. flows: the vault's own ledger rows, newest first. series: equity, chained share price (nav), net flow and PnL per hour or day, oldest first (for a parent vault, its whole family). Its fills, trades and positions: hl_wallet and hl_wallet_activity with the vault address. Same data as GET /v1/hyperliquid/vaults/{vault} and its sub-routes.

Tool call template

This tool declares no required parameters. Add optional parameters from the input schema as needed.

{
  "id": 1,
  "jsonrpc": "2.0",
  "method": "tools/call",
  "params": {
    "arguments": {},
    "name": "hl_vault"
  }
}

Input Schema

NameRequiredDescriptionDefault
endNoISO-8601 UTC upper bound, e.g. 2026-10-02T00:00:00Z. Used by view: series.
sortNoRanking: `share`, `pnl` (on the current position), `all_time_pnl` (since the first deposit) or `entered` (entry time). Used by view: depositors.share
typeNo`all`, `deposit`, `withdraw`, `distribution` or `commission`. Used by view: flows.all
viewNoWhat to read. `profile`: TVL, APR, leverage, depositor concentration and all five windows. `depositors`: current depositors with their equity, PnL, entry and lockup, largest share first. `flows`: the vault's own deposits, withdrawals, distributions and commissions, newest first. `series`: equity, share price, net flow and PnL per hour or day, oldest first. Default `profile`.profile
limitNoRows per page. Default by view: depositors 100, flows 100, series 500. Max by view: depositors 1000, flows 1000, series 5000. Used by view: depositors, flows, series.
orderNo`desc` or `asc`. Used by view: depositors.desc
startNoISO-8601 UTC lower bound, e.g. 2026-10-01T00:00:00Z. Used by view: series.
vaultNoVault address: 0x followed by 40 hex characters. Required.
bucketNoPoint width: `1h` or `1d`. Used by view: series.1d
cursorNo`nextCursor` from the previous page, passed back verbatim; it is null on the last page. Omit it for the first page. Used by view: depositors, flows, series.
windowNoWindow ending on the newest recorded day: `7d`, `30d`, `90d`, `365d` or `all`. Used by view: flows.30d
smart_onlyNoOnly depositors in the top 1,000 of the all-time PnL leaderboard. Used by view: depositors.
min_equity_usdNoSmallest depositor equity in USD, at least 1. Used by view: depositors.

Schema Changelog

Changes observed during successful MCP inspections.

  1. Changed3 schema fields changed
    • changedInput schema / properties / sort / description
      Previous value: -"Ranking: `share`. Used by view: depositors."New value: +"Ranking: `share`, `pnl` (on the current position), `all_time_pnl` (since the first deposit) or `entered` (entry time). Used by view: depositors."
    • changedInput schema / properties / sort / enum
      Previous value: -[
      -  "share"
      -]New value: +[
      +  "share",
      +  "pnl",
      +  "all_time_pnl",
      +  "entered"
      +]
    • changedInput schema / properties / view / description
      Previous value: -"What to read. `profile`: TVL, APR, leverage, depositor concentration and all five windows. `depositors`: current depositors, largest share first. `flows`: the vault's own deposits, withdrawals, distributions and commissions, newest first. `series`: equity, share price, net flow and PnL per hour or day, oldest first. Default `profile`."New value: +"What to read. `profile`: TVL, APR, leverage, depositor concentration and all five windows. `depositors`: current depositors with their equity, PnL, entry and lockup, largest share first. `flows`: the vault's own deposits, withdrawals, distributions and commissions, newest first. `series`: equity, share price, net flow and PnL per hour or day, oldest first. Default `profile`."
  2. Added

TDQS

A3.6/5.0
Behavior3/5

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

Annotations already declare readOnly, idempotent, non-destructive and closed-world, so the safety profile is covered. The description adds real behavioral context beyond that: ordering per view ('newest first' for flows, 'oldest first' for series), the note that depositors returns every current depositor rather than only the largest 100, and that series for a parent vault spans its whole family. It says nothing about rate limits, cost, or error behavior, so this is above baseline but not rich.

Agents need to know what a tool does to the world before calling it. Descriptions should go beyond structured annotations to explain consequences.

Conciseness3/5

Is the description appropriately sized, front-loaded, and free of redundancy?

Front-loaded and reasonably compact, but the per-view explanations substantially duplicate the `view` enum description already present in the schema, and the enumerated metrics ('TVL, APR, leverage, leader and top-5 shares... all five windows') partly restate what the windows enum already lists. The telegraphic fragment style is dense but readable.

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?

No output schema exists, so the description must convey return shape, and it does per view: profile metrics, depositor fields (equity, PnL, all-time PnL, entry time, lockup end, PnL rank), flow ledger rows, and series fields with ordering. For a 13-parameter read tool this is close to sufficient; pagination is delegated to the schema's `cursor` description and the REST endpoint equivalence is a useful anchor.

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 six parameters are enums with defaults documented inline, so the description is not required to carry parameter meaning. It largely paraphrases the schema's `view` enum text (profile/depositors/flows/series) rather than adding new semantics, with only 'chained share price (`nav`)' and the parent-vault family note adding genuine information.

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?

Opens with a specific verb/resource/scope: 'One Hyperliquid vault by address, by `view`', which cleanly separates it from the plural sibling hl_vaults. It further distinguishes the fills/trades/positions surface by routing that data to hl_wallet and hl_wallet_activity, though it never explicitly contrasts itself with hl_vaults.

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

Usage Guidelines4/5

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

Gives an explicit alternative for one case: 'Its fills, trades and positions: hl_wallet and hl_wallet_activity with the vault address.' The four `view` values are described concretely enough to imply which one to pick, but there is no guidance on when to prefer hl_vault over the hl_vaults list endpoint.

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.