# create\_rule

Creates a transaction automation rule with optional conditions and at least one action. If conditions/actions are omitted, MCP infers vendor match and category…

Last updated October 1, 2026

## Access

*   Effect: **Creates data**
*   Required scope: `write` (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": "create_rule",
    "arguments": {
      "name": "Emergency fund"
    }
  }
}
```

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

## Description

```
Creates a transaction automation rule with optional conditions and at least one action. If conditions/actions are omitted, MCP infers vendor match and category actions from the name (e.g. "Auto-categorize Starbucks as Food & Drink"). Rules are limited to 100 per user and may not duplicate an existing rule's conditions and actions.
```

## Input parameters

| Name | Type | Required | Description |
| --- | --- | --- | --- |
| `actions` | object | No |  |
| `conditions` | object | No |  |
| `isActive` | boolean | No |  |
| `isIncome` | boolean | No |  |
| `name` | string | Yes |  |

Full input schema (JSON Schema)

```json
{
  "additionalProperties": false,
  "properties": {
    "actions": {
      "additionalProperties": false,
      "properties": {
        "categorySplits": {
          "items": {
            "additionalProperties": false,
            "properties": {
              "basisPoints": {
                "type": "integer"
              },
              "categoryId": {
                "type": "string"
              }
            },
            "required": [
              "categoryId",
              "basisPoints"
            ],
            "type": "object"
          },
          "type": [
            "null",
            "array"
          ]
        },
        "elseCategoryId": {
          "type": [
            "null",
            "string"
          ]
        },
        "notifications": {
          "additionalProperties": false,
          "properties": {
            "email": {
              "type": "boolean"
            },
            "inApp": {
              "type": "boolean"
            },
            "push": {
              "type": "boolean"
            }
          },
          "required": [
            "push",
            "email",
            "inApp"
          ],
          "type": [
            "null",
            "object"
          ]
        },
        "taxAssessment": {
          "additionalProperties": false,
          "properties": {
            "businessUsePercent": {
              "type": [
                "null",
                "number"
              ]
            },
            "status": {
              "type": "string"
            },
            "theme": {
              "type": "string"
            }
          },
          "required": [
            "status"
          ],
          "type": [
            "null",
            "object"
          ]
        },
        "updateTransactionActions": {
          "additionalProperties": false,
          "properties": {
            "transaction": {
              "additionalProperties": false,
              "properties": {
                "category": {
                  "type": [
                    "null",
                    "string"
                  ]
                },
                "categoryId": {
                  "type": [
                    "null",
                    "string"
                  ]
                },
                "description": {
                  "type": [
                    "null",
                    "string"
                  ]
                },
                "isExcludedFromAnalytics": {
                  "type": [
                    "null",
                    "boolean"
                  ]
                },
                "name": {
                  "type": [
                    "null",
                    "string"
                  ]
                },
                "tagIds": {
                  "items": {
                    "type": "string"
                  },
                  "type": [
                    "null",
                    "array"
                  ]
                },
                "vendorName": {
                  "type": [
                    "null",
                    "string"
                  ]
                }
              },
              "required": [
                "tagIds"
              ],
              "type": "object"
            },
            "transactionFieldMasks": {
              "items": {
                "additionalProperties": false,
                "properties": {
                  "path": {
                    "type": "string"
                  }
                },
                "required": [
                  "path"
                ],
                "type": "object"
              },
              "type": [
                "null",
                "array"
              ]
            }
          },
          "required": [
            "transaction",
            "transactionFieldMasks"
          ],
          "type": "object"
        }
      },
      "required": [
        "updateTransactionActions"
      ],
      "type": [
        "null",
        "object"
      ]
    },
    "conditions": {
      "additionalProperties": false,
      "properties": {
        "accountId": {
          "type": [
            "null",
            "string"
          ]
        },
        "amountRange": {
          "additionalProperties": false,
          "properties": {
            "max": {
              "type": [
                "null",
                "number"
              ]
            },
            "min": {
              "type": [
                "null",
                "number"
              ]
            }
          },
          "type": [
            "null",
            "object"
          ]
        },
        "categoryId": {
          "type": [
            "null",
            "string"
          ]
        },
        "dateRange": {
          "additionalProperties": false,
          "properties": {
            "endDate": {
              "type": [
                "null",
                "string"
              ]
            },
            "startDate": {
              "type": [
                "null",
                "string"
              ]
            }
          },
          "type": [
            "null",
            "object"
          ]
        },
        "merchantNames": {
          "items": {
            "type": "string"
          },
          "type": [
            "null",
            "array"
          ]
        },
        "source": {
          "type": [
            "null",
            "string"
          ]
        },
        "tagIds": {
          "items": {
            "type": "string"
          },
          "type": [
            "null",
            "array"
          ]
        },
        "vendorId": {
          "type": [
            "null",
            "string"
          ]
        },
        "vendorName": {
          "type": [
            "null",
            "string"
          ]
        },
        "vendorNameContains": {
          "type": [
            "null",
            "string"
          ]
        }
      },
      "type": [
        "null",
        "object"
      ]
    },
    "isActive": {
      "type": [
        "null",
        "boolean"
      ]
    },
    "isIncome": {
      "type": [
        "null",
        "boolean"
      ]
    },
    "name": {
      "type": "string"
    }
  },
  "required": [
    "name"
  ],
  "type": "object"
}
```

Source: https://financesavi.com/developers/mcp/tools/create_rule
