list_categories

Lists every transaction category visible to the authenticated user — both the global catalog (e.g. FOOD_AND_DRINK, RENT_AND_UTILITIES, INCOME) and any user-def…

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

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

Description

Lists every transaction category visible to the authenticated user — both the global catalog (e.g. FOOD_AND_DRINK, RENT_AND_UTILITIES, INCOME) and any user-defined categories.

Optional filters: searchHint (e.g. "food", "transportation") and typeHint (e.g. "income", "expense").
When answering the user, prefer displayName + emoji over raw enum names.

Call this when you need a category value for another tool:
  • create_transaction requires a category — use category.name (e.g. FOOD_AND_DRINK) as the category field, or category.id as categoryId for user-defined categories.
  • list_transactions accepts categoryIds — use category.id values to filter.
  • get_spending_analytics breaks down totals by category automatically.

Input parameters

NameTypeRequiredDescription
searchHintstringNo
typeHintstringNo
Full input schema (JSON Schema)
json
{
  "additionalProperties": false,
  "properties": {
    "searchHint": {
      "type": [
        "null",
        "string"
      ]
    },
    "typeHint": {
      "type": [
        "null",
        "string"
      ]
    }
  },
  "type": "object"
}