MngGetAITools¶

GET ai/tools

The catalogue for the tool checkboxes of an agent form. Every entry says which platform command it calls and whether that command is published on the bus right now.

A tool whose command is missing is simply not offered to the model. That is why the whole list can be enabled in advance: a tool starts working by itself once the platform publishes its command, with no change on the module side.

Access Control¶

Allowed: admin.

Request¶

RESTTCPSDK

GET request

GET https://{broker_domain}/ai/tools
Authorization: <JWT_TOKEN>

{
  "command": "MngGetAITools",
  "extID": "1",
  "data": {}
}

const tools = await platform.MngGetAITools({});

Response Data¶

{
  "rows": [
    {
      "name": "get_account_balance",
      "action": "GetAccountBalance",
      "description": "Current balance, equity, margin and margin level of a trading account.",
      "sessions": [1, 2, 3, 10, 11, 0, 9],
      "readOnly": true,
      "available": true
    }
  ],
  "count": 12,
  "available": 12
}

Field	Meaning
`name`	The name the model sees
`action`	The platform command behind it
`sessions`	Session types allowed to use it; client types are `0` and `9`
`readOnly`	Always `true` — the registry contains no state-changing command
`available`	Whether the command is on the bus at this moment

available: false on a tool the interface expects is a platform build issue, not a module one. AIHealth reports the same information in its platform block, with the list of missing commands.

Errors¶

Code	Error	Description
`403`	`AI_ACCESS_DENIED`	The session is not an administrator