ListPositions
Returns current positions for one account, all accounts, or a subset. Pair with ListOrders to build a full picture of open risk.
| Property | Value |
|---|---|
| Required scope | mcp:read |
| Risk | None. Read-only. |
| Side effects | None. |
When an agent should use it
- Before any write action.
- Before answering "what am I in?"
- In an end-of-session audit to verify everything is flat.
When an agent should not use it
- For market price reads. Use
GetQuoteinstead.
Parameters
{ "account": "Sim101" }
GetAllPositions is the all-accounts variant.
Response shape
{
"positions": [
{
"account": "Sim101",
"instrument": "MES 06-26",
"quantity": 2,
"market_position": "Long",
"average_price": 5240.25,
"unrealized_pnl": 75.00
}
]
}
Example user prompt
List positions on Sim101. For anything open, tell me instrument, side, quantity,
average price, and unrealized P&L. If there are working orders against any of these
positions, mention which ones.
Example tool call
{ "name": "ListPositions", "arguments": { "account": "Sim101" } }
Common errors
| Symptom | Likely cause | Fix |
|---|---|---|
| Empty array unexpectedly | Account is connected but flat. | Confirm with GetAccountSummary. |
addon_disconnected | Add-on side is down. | Open NT8. |
Safe workflow placement
Use as the first read after GetAccountSummary / GetWatermarks. The agent should be able to recite the open position before any write action.