Sign in
Docs
0%

Transports

Accounts, part 1 of 2 MCP tools

The 19 tools /mcp offers for Accounts, part 1 of 2, what each needs and an example call.

Your account's appearance, layouts, prompts, usage and limits, domains, client policies and monitor boards. These are 19 tools of the 38 tools of the accounts backend (part 1 of 2; the others are part 2); all MCP tools lists the other backends.

accounts_delete_theme

Delete a colour theme. Delete one of your colour themes. If it was your current theme, your appearance goes back to the theme's base preset. Returns your appearance.

Scopes: mcp:write · changes something · may overwrite or remove · safe to repeat

ArgumentTypeWhat it is
idstring
{
  "jsonrpc": "2.0",
  "id": 1,
  "method": "tools/call",
  "params": {
    "name": "accounts_delete_theme",
    "arguments": {}
  }
}

accounts_get_appearance

My appearance. Your colour mode (system, light or dark) and colour theme: a preset (default, amber, violet, indigo, green or mocha) or custom:<theme id> for a theme you made, and when it last changed. Defaults to system and default.

Scopes: mcp:read · reads only

No arguments.

{
  "jsonrpc": "2.0",
  "id": 1,
  "method": "tools/call",
  "params": {
    "name": "accounts_get_appearance",
    "arguments": {}
  }
}

accounts_get_client_fleet

Show a client's fleet. Which versions of a client type the gateway saw in the last days (1 to 90, 0 means 30): the share per version and how it stands, the share behind the latest and below the minimum, adoption by day, and the agents and keys most behind (query narrows them). No account names or people's ids. The platform's admins only.

Scopes: mcp:read · reads only

ArgumentTypeWhat it is
clientstring
daysintegerDays of adoption to answer, 1 to 90 (0: 30).
querystringNarrow the clients most behind: an account, a label or an id.
{
  "jsonrpc": "2.0",
  "id": 1,
  "method": "tools/call",
  "params": {
    "name": "accounts_get_client_fleet",
    "arguments": {}
  }
}

accounts_get_domain

Get domain. Calls iohr.accounts.v1.AccountsService/GetDomain.

Scopes: mcp:read, domains:read · reads only

ArgumentTypeWhat it is
account_idstringThe account's id; an alias of org_id. Leave both out for the caller's own account.
domainstring
org_idstring
{
  "jsonrpc": "2.0",
  "id": 1,
  "method": "tools/call",
  "params": {
    "name": "accounts_get_domain",
    "arguments": {}
  }
}

accounts_get_entitlements

Get entitlements. Entitlements: the account's plan, the features it may use, sorted, and the extensions it may install (none yet; the field is there for the extension marketplace). Every plan's features are data in the service's configuration. InOrbit's own accounts and the platform's admin have every feature whatever the plan. A member of the account, a key or token of the account (account:read), or the platform's admin for any account; anyone else is NOT_FOUND.

Scopes: mcp:read, account:read · reads only

ArgumentTypeWhat it is
account_idstringThe account's id; an alias of org_id. Leave both out for the caller's own account.
org_idstring
{
  "jsonrpc": "2.0",
  "id": 1,
  "method": "tools/call",
  "params": {
    "name": "accounts_get_entitlements",
    "arguments": {}
  }
}

accounts_get_layout

Get a dashboard layout. The layout a page shows the caller: their own, else the account's default, else the page's own (origin default, no widgets). Also the default on its own and whether the caller may change it.

Scopes: mcp:read, account:read · reads only

ArgumentTypeWhat it is
account_idstringThe account's id; an alias of org_id. Leave both out for the caller's own account.
org_idstring
pagestring
{
  "jsonrpc": "2.0",
  "id": 1,
  "method": "tools/call",
  "params": {
    "name": "accounts_get_layout",
    "arguments": {}
  }
}

accounts_get_me

Who am I. Who is calling: the person (or API key) the gateway verified, their own account, the team accounts they belong to, and for a key the scopes it carries. Use it first to learn which account_id to pass to the other tools. Your remaining model budget is llm_get_budget; the spaces of an account are decisions_list_spaces.

Scopes: mcp:read, account:read · reads only

No arguments.

{
  "jsonrpc": "2.0",
  "id": 1,
  "method": "tools/call",
  "params": {
    "name": "accounts_get_me",
    "arguments": {}
  }
}

accounts_get_monitor_board

Get the monitors board. How an account's monitors page is organised: its own categories (id, name, colour) on top of the six built in, their order, which category a monitor was moved to (over the category the monitor or the agent's checks.toml declares, which stays as it is), the order inside each, and the caller's own view (pins, collapsed categories, sort, list or cards). Monitors themselves are connections_list_monitors.

Scopes: mcp:read, account:read · reads only

ArgumentTypeWhat it is
account_idstringThe account's id; an alias of org_id. Leave both out for the caller's own account.
org_idstring
{
  "jsonrpc": "2.0",
  "id": 1,
  "method": "tools/call",
  "params": {
    "name": "accounts_get_monitor_board",
    "arguments": {}
  }
}

accounts_get_notification_sounds

My notification sounds. The signed-in person's notification sounds: the sound for each kind of notification (critical, high, low, approval, resolved, message, tick) as a library id, tone:<tone_id> or silent; their own tones as ringtone specs; whether critical pages break through Do Not Disturb; the repeat rule and escalation steps; and the revision to save with.

Scopes: mcp:read · reads only

No arguments.

{
  "jsonrpc": "2.0",
  "id": 1,
  "method": "tools/call",
  "params": {
    "name": "accounts_get_notification_sounds",
    "arguments": {}
  }
}

accounts_get_preferences

My account preferences. The signed-in person's account preferences: the account they made their default, the one they used last, and the account the console opens on (open_account_id) with why (default, last, only_team, suggested, recent_team or personal).

Scopes: mcp:read · reads only

No arguments.

{
  "jsonrpc": "2.0",
  "id": 1,
  "method": "tools/call",
  "params": {
    "name": "accounts_get_preferences",
    "arguments": {}
  }
}

accounts_get_prompts

My one-time prompts. The signed-in person's one-time in-app prompts (today app_welcome_video): open, later (with when it asks again), done or never, and whether the app may offer it now.

Scopes: mcp:read · reads only

No arguments.

{
  "jsonrpc": "2.0",
  "id": 1,
  "method": "tools/call",
  "params": {
    "name": "accounts_get_prompts",
    "arguments": {}
  }
}

accounts_get_spending_limit

Spending limit. An account's overage and monthly spending limit: whether overage runs, the limit and its currency, what it buys in units and the units past the allowance this month. Read only: an owner or admin changes the limit in the console. org_id is the account (accounts_get_me names yours).

Scopes: mcp:read, usage:read · reads only

ArgumentTypeWhat it is
account_idstringThe account's id; an alias of org_id. Leave both out for the caller's own account.
org_idstringThe account; "" is the caller's own.
{
  "jsonrpc": "2.0",
  "id": 1,
  "method": "tools/call",
  "params": {
    "name": "accounts_get_spending_limit",
    "arguments": {}
  }
}

accounts_get_traffic

An account's traffic. An account's calls to InOrbit over a window (window: 5m, 15m, 1h, 6h or 24h; until: RFC 3339, default now; rpc_prefix narrows to one service, such as iohr.billing.): about 30 buckets of calls, failures and p50/p95, the totals with error rate and calls a minute, the 10 operations failing most with their top code, and the last 20 failed calls (operation, code, time, request id). Never a key, a person or a body. Percentiles are approximate (t-digest). org_id is the account (accounts_get_me names yours).

Scopes: mcp:read, usage:read · reads only

ArgumentTypeWhat it is
account_idstringThe account's id; an alias of org_id. Leave both out for the caller's own account.
org_idstring
rpc_prefixstringOnly operations whose full name starts with this, such as "iohr.billing."; at most 128 characters; empty for all.
untilstringRFC 3339: the window ends here; empty is now. Within the log's 30 days.
windowstring5m, 15m, 1h, 6h or 24h; empty is 15m.
{
  "jsonrpc": "2.0",
  "id": 1,
  "method": "tools/call",
  "params": {
    "name": "accounts_get_traffic",
    "arguments": {}
  }
}

accounts_get_unit_series

Get unit series. The account's calls, tokens and units per UTC day over a window (30 days by default, 92 at most), split by who made them, category or operation. The four largest groups are named and the rest summed as "everything else". Who may read it is as for GetUnits.

Scopes: mcp:read, usage:read · reads only

ArgumentTypeWhat it is
account_idstringThe account's id; an alias of org_id. Leave both out for the caller's own account.
bystring"who" (a key, or a person on the sites), "category", "operation", or empty for the account's total.
fromstringYYYY-MM-DD, UTC, inclusive; to is today and from 29 days before it when empty.
org_idstring
tostring
{
  "jsonrpc": "2.0",
  "id": 1,
  "method": "tools/call",
  "params": {
    "name": "accounts_get_unit_series",
    "arguments": {}
  }
}

accounts_get_units

Get units. Units: the account's units this month: the plan, the allowance, what was used by category, operation and key, and what remains (a member, a key for its own account, or the platform's admin for any account).

Scopes: mcp:read, usage:read · reads only

ArgumentTypeWhat it is
account_idstringThe account's id; an alias of org_id. Leave both out for the caller's own account.
org_idstring
{
  "jsonrpc": "2.0",
  "id": 1,
  "method": "tools/call",
  "params": {
    "name": "accounts_get_units",
    "arguments": {}
  }
}

accounts_get_usage

Get usage. What the account used, by day, service and metric (a member, or a key for its own account).

Scopes: mcp:read, usage:read · reads only

ArgumentTypeWhat it is
account_idstringThe account's id; an alias of org_id. Leave both out for the caller's own account.
fromstringYYYY-MM-DD, inclusive; the last 30 days when empty.
org_idstring
tostring
{
  "jsonrpc": "2.0",
  "id": 1,
  "method": "tools/call",
  "params": {
    "name": "accounts_get_usage",
    "arguments": {}
  }
}

accounts_get_usage_limits

My usage limits. Your rolling windows for the scarce work (model generations and sandbox runs): each window's limit in force now, what you used, what remains, when room comes back (resets_at) and a reason in plain words, sized to the platform's capacity (load idle, normal or busy; capacity_source says whether that is configured or measured). admits is false while a window is limited. An empty account_id is your own; an owner or admin may pass a member's user_id. Check it before a long run of generations or investigations.

Scopes: mcp:read · reads only

ArgumentTypeWhat it is
account_idstringThe account's id; an alias of org_id. Leave both out for the caller's own account.
org_idstringThe account; empty is the caller's own.
user_idstringA member of the account (their user id); empty is the caller.
{
  "jsonrpc": "2.0",
  "id": 1,
  "method": "tools/call",
  "params": {
    "name": "accounts_get_usage_limits",
    "arguments": {}
  }
}

accounts_get_widget_branding

Ask Io widget branding. The account's Ask Io widget: its widget_id, the branding stored (name, tagline, avatar_url, logo_url, colours), its revision, whether its plan lets custom branding show (custom_branding_allowed, plan, required_plan) and the config the public widget answers now (its title is always AI Agent). An empty org_id is the caller's own account; only the account's owner or an admin, or a key of the account with account:read.

Scopes: mcp:read, account:read · reads only

ArgumentTypeWhat it is
account_idstringThe account's id; an alias of org_id. Leave both out for the caller's own account.
org_idstring
{
  "jsonrpc": "2.0",
  "id": 1,
  "method": "tools/call",
  "params": {
    "name": "accounts_get_widget_branding",
    "arguments": {}
  }
}

accounts_import_client_release_notes

Read a client release's notes. The release notes of a version (tag; empty: the draft's latest) as markdown, from the GitHub release under the policy's links.source, else the section of links.changelog. Saves nothing: put them in a draft's notes_md to keep them. The platform's admins only.

Scopes: mcp:read · reads only · reaches outside the platform

ArgumentTypeWhat it is
clientstring
tagstringThe release's tag; empty: the latest version's.
{
  "jsonrpc": "2.0",
  "id": 1,
  "method": "tools/call",
  "params": {
    "name": "accounts_import_client_release_notes",
    "arguments": {}
  }
}