Skip to main content
Glama

fxapis — MetaTrader 5

Symbol snapshot

get_symbol_snapshot
Read-onlyIdempotent

One symbol on one account in one call: its specification, live quote, whether the market is open, and the margin for a volume. Use it before proposing a trade. Example: {"account_id": "", "instrument": "XAUUSD", "volume": "0.10", "side": "buy"}

Input Schema

TableJSON Schema
NameRequiredDescriptionDefault
sideNobuy (default) or sell, for the margin.
symbolNoThe symbol exactly as this broker names it, e.g. "EURUSD" — some brokers add a suffix such as "EURUSD.r".
volumeNoOptional: the size to price the margin for. In lots, preferably as a string: "0.01" is a micro lot, "1.00" a standard lot.
account_idYesThe fxapis account id (a UUID) from list_accounts — not the MT5 login number.
instrumentNoInstead of symbol: an instrument from list_instruments, e.g. XAUUSD.
response_formatNoconcise (default): what a next step needs. detailed: every field the API returns.

Output Schema

TableJSON Schema
NameRequiredDescriptionDefault
quoteYes
marginYes
marketYes
symbolYes
unavailableYes
specificationYes

Schema Changelog

Changes observed during successful MCP inspections.

  1. First observed

TDQS

A3.8/5.0
Behavior3/5

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

Annotations already declare readOnlyHint, idempotentHint, openWorldHint and destructiveHint=false, so the safety profile is covered. The description adds that this is a single-call aggregate of live broker data and that margin is computed for a given volume/side, but says nothing about data freshness, latency, or failure modes when the symbol is unknown.

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?

Two tight sentences front-load the payload, with a call example appended. Slight redundancy in re-listing return contents that the output schema already covers, but no sentence is wasted.

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 needn't document returns, yet it usefully summarizes them and points account_id at list_accounts and instrument at list_instruments. The main omission is routing guidance against the many sibling read tools (get_quotes, get_market_hours, list_instruments).

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 baseline is 3. The example call goes beyond the schema by demonstrating the practical pairing (account_id + instrument + volume as the string "0.10" + side), which clarifies the symbol/instrument alternative and string-lot convention in context.

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 names a specific resource (one symbol on one account) and enumerates the payload: specification, live quote, market-open status, and margin for a volume. That scope is clear enough to separate it from point tools like get_quotes or get_market_hours, though no sibling is named explicitly.

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?

"Use it before proposing a trade" gives a concrete usage context rather than leaving timing to inference. It stops short of naming alternatives (e.g. when to prefer get_quotes or get_market_hours instead) or stating when-not-to-use, so it is strong but not exhaustive.

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