list_rules

Lists transaction automation rules. Use rule.id as ruleId in update_rule or delete_rule.

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": "list_rules",
    "arguments": {}
  }
}

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

Description

Lists transaction automation rules. Use rule.id as ruleId in update_rule or delete_rule.

Input parameters

NameTypeRequiredDescription
accountIdstringNo
isActivebooleanNo
isIncomebooleanNo
namestringNo
vendorNamestringNo
Full input schema (JSON Schema)
json
{
  "additionalProperties": false,
  "properties": {
    "accountId": {
      "type": [
        "null",
        "string"
      ]
    },
    "isActive": {
      "type": [
        "null",
        "boolean"
      ]
    },
    "isIncome": {
      "type": [
        "null",
        "boolean"
      ]
    },
    "name": {
      "type": [
        "null",
        "string"
      ]
    },
    "vendorName": {
      "type": [
        "null",
        "string"
      ]
    }
  },
  "type": "object"
}