← BSV MCPInstall
Wallet

wallet_read

Read-only wallet operations. Select operation and pass that operation's arguments in args.

Read as Markdown

Result

The selected full-tool operation's result, wrapped by the compact dispatcher.

Permissions

Uses the selected wallet's read permissions. Whole-wallet balance is absent for external signers.

Operations

Pass the full tool name as operation and its input object as args. Available operations vary by wallet configuration.

Definition 1

Compact catalog · Legacy local wallet; Legacy local identity

FieldType / requiredDescription
operation"wallet_getAddress" | "wallet_getBalance" | "wallet_getOrdinals" | "wallet_listTokens" | "wallet_getBsv21Balances" | "wallet_getLockData"
Required
See schema for details.
argsobject
Optional
See schema for details.

default: {}

Nested fields are required only when their parent object or array item is supplied.

Full input schema
{
  "type": "object",
  "properties": {
    "operation": {
      "type": "string",
      "enum": [
        "wallet_getAddress",
        "wallet_getBalance",
        "wallet_getOrdinals",
        "wallet_listTokens",
        "wallet_getBsv21Balances",
        "wallet_getLockData"
      ]
    },
    "args": {
      "default": {},
      "type": "object",
      "propertyNames": {
        "type": "string"
      },
      "additionalProperties": {}
    }
  },
  "required": [
    "operation"
  ],
  "$schema": "https://json-schema.org/draft/2020-12/schema"
}

Definition 2

Compact catalog · Local Vault · broadcasting disabled; Local Vault · all roles; Local Vault + sponsor

FieldType / requiredDescription
operation"wallet_getAddress" | "wallet_getBalance" | "wallet_getOrdinals" | "wallet_listTokens" | "wallet_getBsv21Balances" | "wallet_getLockData" | "wallet_getHeight" | "wallet_getHeaderForHeight" | "wallet_getNetwork" | "wallet_getVersion" | "wallet_getPublicKey" | "wallet_isAuthenticated" | "wallet_waitForAuthentication"
Required
See schema for details.
argsobject
Optional
See schema for details.

default: {}

Nested fields are required only when their parent object or array item is supplied.

Full input schema
{
  "type": "object",
  "properties": {
    "operation": {
      "type": "string",
      "enum": [
        "wallet_getAddress",
        "wallet_getBalance",
        "wallet_getOrdinals",
        "wallet_listTokens",
        "wallet_getBsv21Balances",
        "wallet_getLockData",
        "wallet_getHeight",
        "wallet_getHeaderForHeight",
        "wallet_getNetwork",
        "wallet_getVersion",
        "wallet_getPublicKey",
        "wallet_isAuthenticated",
        "wallet_waitForAuthentication"
      ]
    },
    "args": {
      "default": {},
      "type": "object",
      "propertyNames": {
        "type": "string"
      },
      "additionalProperties": {}
    }
  },
  "required": [
    "operation"
  ],
  "$schema": "https://json-schema.org/draft/2020-12/schema"
}

Definition 3

Compact catalog · Local Vault · payment role only

FieldType / requiredDescription
operation"wallet_getAddress" | "wallet_getBalance" | "wallet_getHeight" | "wallet_getHeaderForHeight" | "wallet_getNetwork" | "wallet_getVersion" | "wallet_getPublicKey" | "wallet_isAuthenticated" | "wallet_waitForAuthentication"
Required
See schema for details.
argsobject
Optional
See schema for details.

default: {}

Nested fields are required only when their parent object or array item is supplied.

Full input schema
{
  "type": "object",
  "properties": {
    "operation": {
      "type": "string",
      "enum": [
        "wallet_getAddress",
        "wallet_getBalance",
        "wallet_getHeight",
        "wallet_getHeaderForHeight",
        "wallet_getNetwork",
        "wallet_getVersion",
        "wallet_getPublicKey",
        "wallet_isAuthenticated",
        "wallet_waitForAuthentication"
      ]
    },
    "args": {
      "default": {},
      "type": "object",
      "propertyNames": {
        "type": "string"
      },
      "additionalProperties": {}
    }
  },
  "required": [
    "operation"
  ],
  "$schema": "https://json-schema.org/draft/2020-12/schema"
}

Definition 4

Compact catalog · Project · payments scope

FieldType / requiredDescription
operation"wallet_getAddress" | "wallet_getBalance"
Required
See schema for details.
argsobject
Optional
See schema for details.

default: {}

Nested fields are required only when their parent object or array item is supplied.

Full input schema
{
  "type": "object",
  "properties": {
    "operation": {
      "type": "string",
      "enum": [
        "wallet_getAddress",
        "wallet_getBalance"
      ]
    },
    "args": {
      "default": {},
      "type": "object",
      "propertyNames": {
        "type": "string"
      },
      "additionalProperties": {}
    }
  },
  "required": [
    "operation"
  ],
  "$schema": "https://json-schema.org/draft/2020-12/schema"
}

Definition 5

Compact catalog · External BRC-100 wallet

FieldType / requiredDescription
operation"wallet_getAddress" | "wallet_getOrdinals" | "wallet_listTokens" | "wallet_getBsv21Balances" | "wallet_getLockData" | "wallet_getHeight" | "wallet_getHeaderForHeight" | "wallet_getNetwork" | "wallet_getVersion" | "wallet_getPublicKey" | "wallet_isAuthenticated" | "wallet_waitForAuthentication"
Required
See schema for details.
argsobject
Optional
See schema for details.

default: {}

Nested fields are required only when their parent object or array item is supplied.

Full input schema
{
  "type": "object",
  "properties": {
    "operation": {
      "type": "string",
      "enum": [
        "wallet_getAddress",
        "wallet_getOrdinals",
        "wallet_listTokens",
        "wallet_getBsv21Balances",
        "wallet_getLockData",
        "wallet_getHeight",
        "wallet_getHeaderForHeight",
        "wallet_getNetwork",
        "wallet_getVersion",
        "wallet_getPublicKey",
        "wallet_isAuthenticated",
        "wallet_waitForAuthentication"
      ]
    },
    "args": {
      "default": {},
      "type": "object",
      "propertyNames": {
        "type": "string"
      },
      "additionalProperties": {}
    }
  },
  "required": [
    "operation"
  ],
  "$schema": "https://json-schema.org/draft/2020-12/schema"
}