Skip to main content
Glama

Ironflow: Hyperliquid data

Get Ironbox

get_ironbox
Read-only

One Ironbox by id: its state (creating, running, stopped, deleted or error), size, mode, runtime, Hyperliquid markets and region.

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": {
      "id": "<id>"
    },
    "name": "get_ironbox"
  }
}

Input Schema

NameRequiredDescriptionDefault
idYesIronbox id (ibx_...) from create_ironbox or list_ironboxes

Output Schema

NameRequiredDescriptionDefault
idNoIronbox id (ibx_...)
urlNoThis Ironbox in the API
modeNopaper (simulated funds) or live
nameNoName
sizeNosmall, medium or large
paperNoTrue on a paper box: the agent's own simulated Hyperliquid account
stateNocreating, running, stopped, deleted or error
trialNoTrue on a keyless trial box
noticeNoPresent when the API added a note: how a market name was read, that data starts later than asked because of the history window, or a next step such as a free key
regionNoWhere it runs, e.g. tokyo
marketsNoMarkets the agent trades: perps, outcomes, spot
messageNoWhat happens next, from the API
runtimeNopython or node
snippetNoA first Python program for this box. Shown only when created or rotated
base_urlNoSet the Hyperliquid SDK's base_url to this. Shown only when a paper box is created or rotated
dashboardNoWhere the user manages it on ironflow.sh
created_atNoCreation time, Unix milliseconds
expires_atNoWhen a trial box ends at the latest, Unix milliseconds
activity_urlNoWhere to watch this box. Shown only with base_url
strategies_urlNoWhere to start strategies on this box. Shown only with base_url
starting_balance_usdNoStarting balance of a new paper box

Schema Changelog

Changes observed during successful MCP inspections.

  1. Changed3 schema fields changed
    • addedOutput schema / properties / activity_url
      Added value: +{
      +  "description": "Where to watch this box. Shown only with base_url"
      +}
    • changedOutput schema / properties / expires_at / description
      Previous value: -"When a trial box ends and is removed, Unix milliseconds"New value: +"When a trial box ends at the latest, Unix milliseconds"
    • addedOutput schema / properties / strategies_url
      Added value: +{
      +  "description": "Where to start strategies on this box. Shown only with base_url"
      +}
  2. Changed6 schema fields changed
    • addedOutput schema / properties / base_url
      Added value: +{
      +  "description": "Set the Hyperliquid SDK's base_url to this. Shown only when a paper box is created or rotated"
      +}
    • addedOutput schema / properties / expires_at
      Added value: +{
      +  "description": "When a trial box ends and is removed, Unix milliseconds"
      +}
    • addedOutput schema / properties / paper
      Added value: +{
      +  "description": "True on a paper box: the agent's own simulated Hyperliquid account"
      +}
    • addedOutput schema / properties / snippet
      Added value: +{
      +  "description": "A first Python program for this box. Shown only when created or rotated"
      +}
    • addedOutput schema / properties / starting_balance_usd
      Added value: +{
      +  "description": "Starting balance of a new paper box"
      +}
    • addedOutput schema / properties / trial
      Added value: +{
      +  "description": "True on a keyless trial box"
      +}
  3. Added

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=true, so the safety profile is covered. The description adds value by enumerating the state machine (creating, running, stopped, deleted, error), which tells the agent what lifecycle values to expect. It says nothing about behavior for missing/invalid ids or whether deleted boxes remain retrievable.

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?

A single front-loaded sentence with no filler; every listed attribute is informative. It is telegraphic to the point of dropping the verb, which slightly hurts readability but not economy.

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?

An output schema exists, so return-field explanation is not owed, yet the description still summarizes the important ones. For a one-parameter read tool the definition is essentially complete; only error/edge-case behavior is unaddressed.

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 coverage is 100% and the single id parameter is fully documented in the schema, including its origin (ibx_... from create_ironbox or list_ironboxes). The description's "by id" adds nothing beyond that, so baseline 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?

"One Ironbox by id" identifies a single-resource retrieval and enumerates the salient fields returned (state, size, mode, runtime, markets, region), which cleanly distinguishes it from list_ironboxes. The verb is elided (no explicit "get/retrieve"), and no sibling is named, so it falls short of the top mark.

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?

Usage is only implied: "by id" signals a single-record lookup, and the schema notes the id comes from create_ironbox or list_ironboxes. There is no explicit statement of when to prefer this over list_ironboxes or get_status, and no preconditions or exclusions are given.

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.