What this caller may do
get_accessThe caller's plan, allowances remaining, currency and market.
Answers "what can I do here". Useful before a build or backtest, which each
spend a monthly allowance, and after a refusal that mentions a limit. It
counts as one call and spends no build or backtest allowance.
``excluded_tools`` lists tools this plan does not include; those are refused
regardless of arguments.
``counted: false`` on a meter means the counter could not be read and its
figures are unknown.
Tool call template
This tool declares no required parameters. Add optional parameters from the input schema as needed.
{
"id": 1,
"jsonrpc": "2.0",
"method": "tools/call",
"params": {
"arguments": {},
"name": "get_access"
}
}Input Schema
| Name | Required | Description | Default |
|---|---|---|---|
| person_id | No | The id of one person, family or entity this login holds. Omit for everything this login holds. |
Output Schema
| Name | Required | Description | Default |
|---|---|---|---|
| plan | Yes | The plan name, e.g. `free`. | |
| tools | No | Every tool this plan includes, sorted. | |
| metered | No | Empty on an unmetered plan, which means no ceilings. | |
| currency | Yes | The client's currency. Every strategy this surface can build is denominated in it. | |
| plan_title | Yes | ||
| jurisdiction | No | Where the client is booked, or None where their person node records nothing. It narrows which home markets appear on the shelf; it grants nothing. | |
| excluded_tools | No | Registered on this server but NOT in this plan. Calling one is refused whatever the arguments; a retry does not change that. |