read_account

Reads one account by accountId for the authenticated user.

Use with an AI agent

Export this page as Markdown or bundle it with a task for your agent.

Try a task
Preview the prompt that will be copied

Access

  • Effect: Read-only
  • Required scope: read (the mcp scope also grants it)

Example request

The JSON-RPC message an MCP client sends to call this tool. Your client builds it for you; this is for reference and debugging in a tool such as MCP Inspector.

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

Example IDs refer to fictional demo data. Replace them with IDs from your account before calling the real server.

Description

Reads one account by accountId for the authenticated user.

Set includeExactComputedBalance=true to read a computed balance as string units and decimal scale.

Use this when you already have an accountId (from list_accounts or create_account) and need full account details.

If accountId is unknown, call list_accounts first and use account.id, or pass accountName to resolve automatically.

Input parameters

NameTypeRequiredDescription
accountIdstringNo
accountNamestringNo
includeCollaboratorInvitationsbooleanNo
includeCollaboratorsbooleanNo
includeComputedBalancebooleanNo
includeCryptoHoldingsbooleanNo
includeExactComputedBalancebooleanNo
includePlaidAccessObjectbooleanNo
Full input schema (JSON Schema)
json
{
  "additionalProperties": false,
  "properties": {
    "accountId": {
      "type": "string"
    },
    "accountName": {
      "type": [
        "null",
        "string"
      ]
    },
    "includeCollaboratorInvitations": {
      "type": [
        "null",
        "boolean"
      ]
    },
    "includeCollaborators": {
      "type": [
        "null",
        "boolean"
      ]
    },
    "includeComputedBalance": {
      "type": [
        "null",
        "boolean"
      ]
    },
    "includeCryptoHoldings": {
      "type": [
        "null",
        "boolean"
      ]
    },
    "includeExactComputedBalance": {
      "type": [
        "null",
        "boolean"
      ]
    },
    "includePlaidAccessObject": {
      "type": [
        "null",
        "boolean"
      ]
    }
  },
  "type": "object"
}