htx-mcp

HTX Get Spot Margin Snapshot

htx_get_spot_margin_snapshot

Read-onlyIdempotent

Retrieve spot-margin balances, debt/risk metrics, and loan quotas to preflight borrowing, repayment, or margin-funded trades.

Instructions

Return compact spot-margin balances, debt/risk fields, and current loan quotas.

This read-only preflight is designed to precede borrowing, repayment, or any margin-funded trade.

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": {
      "margin_mode": "<margin_mode>"
    },
    "name": "htx_get_spot_margin_snapshot"
  }
}

Input Schema

Name	Required	Description
`instrument`	No	Required isolated-margin symbol; omit for cross margin.
`include_raw`	No	When true, include the original HTX envelopes in addition to compact normalized data.
`margin_mode`	Yes	Spot-margin mode: isolated per symbol or cross across currencies.

Output Schema

Name	Required	Description	Default
No arguments

Schema Changelog

Changes observed during successful MCP inspections.

First observedv0.7.3Sep 8, 2026

TDQS

A4.3/5.0

Behavior4/5

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

Annotations already declare readOnlyHint, idempotentHint, and destructiveHint=false. The description adds useful behavior beyond that by noting it returns normalized compact data and loan quotas, and that it is intended as a safe preflight check. This is sufficient given the strong annotation coverage.

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?

The description is two tight sentences with no filler. The first sentence front-loads the output, and the second adds the key usage context, so every sentence earns its place.

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

Completeness5/5

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

The tool is simple with three well-documented parameters, a full output schema, and comprehensive annotations. The description adds the missing usage intent and data scope, making it complete for an agent to select and invoke correctly.

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%, with each parameter already explained including defaults and the conditional use of instrument for isolated margin. The description itself adds no parameter-level detail beyond the schema, so the baseline 3 is appropriate.

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?

The description uses a specific verb ('Return') plus a clear resource ('compact spot-margin balances, debt/risk fields, and current loan quotas'), which states exactly what the tool produces. The spot-margin scope separates it from sibling snapshots like account, portfolio, market, and risk snapshots, so an agent can tell it apart.

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?

The description explicitly positions the tool as a 'read-only preflight' for borrowing, repayment, or margin-funded trades, giving clear when-to-use context. It does not explicitly name alternatives or state when not to use it, but the usage scenario is specific enough to guide selection.

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

Deploy Server