Skip to main content
Glama
Universal Firefly III AI Bridge

Universal Firefly III AI Bridge

by fabianonetto

Universal Firefly III AI Bridge (v3.0.0)

A professional-grade, AI-agnostic bridge providing exhaustive 100% API coverage for connecting AI assistants to your Firefly III personal finance instance.

66 tools covering every major Firefly III capability: accounts, transactions, budgets, bills, recurring rules, automation, insights, attachments, currencies, and more.


Compatibility

AI Platform

Protocol

Connection

Setup Guide

Claude Code

MCP (Native)

stdio

CLAUDE.md

Claude Desktop

MCP (Native)

stdio

CLAUDE.md

Gemini CLI

MCP Extension

stdio

gemini.md

Cursor / VS Code

MCP

stdio or SSE

Manual setup below

ChatGPT

OpenAPI Actions

REST / JSON

/openapi.json endpoint

Custom Apps

REST API

HTTP

/api/<tool> endpoints


Related MCP server: YNAB Assistant

Installation

Prerequisites

  • Node.js v18 or later

  • A running Firefly III instance

  • A Personal Access Token from Firefly III
    (Profile → OAuth → Personal Access Tokens → Create new token)

Clone and install

git clone https://github.com/fabianonetto/mcp-server-firefly-iii.git
cd mcp-server-firefly-iii
npm install

Setup by Platform

Claude Code uses .mcp.json in the project directory for MCP server configuration. Credentials go in a separate .env file so no secrets are ever in config files.

1. Create .env in the repo root (gitignored — never committed):

FIREFLY_URL=http://your-host:PORT
FIREFLY_TOKEN=your_personal_access_token

Get your token: Firefly III → Profile → OAuth → Personal Access Tokens → Create new token

2. Create .mcp.json in the repo root (gitignored — never committed):

{
  "mcpServers": {
    "firefly-iii": {
      "command": "node",
      "args": ["./index.js"]
    }
  }
}

The server reads credentials from .env automatically. No secrets in .mcp.json.

3. Start Claude Code from the repo directory:

claude

The server starts automatically. Claude Code will prompt you to approve it on first launch (once only).

4. Verify the connection by asking:

Use the get_about tool

You should receive your Firefly III version and API information.

Using from other projects:
Copy both .env and .mcp.json to any other project directory, changing ./index.js to the absolute path:

"args": ["/absolute/path/to/mcp-server-firefly-iii/index.js"]

See CLAUDE.md for the full guide including auto-approval configuration.


Claude Desktop

Add the server to your Claude Desktop config file:

  • macOS: ~/Library/Application Support/Claude/claude_desktop_config.json

  • Windows: %APPDATA%\Claude\claude_desktop_config.json

{
  "mcpServers": {
    "firefly-iii": {
      "command": "node",
      "args": ["/absolute/path/to/mcp-server-firefly-iii/index.js"],
      "env": {
        "FIREFLY_URL": "http://your-host:PORT",
        "FIREFLY_TOKEN": "your_personal_access_token"
      }
    }
  }
}

Restart Claude Desktop after saving.


Gemini CLI Extension (One-command install)

gemini extensions install https://github.com/fabianonetto/mcp-server-firefly-iii

Then configure your instance:

gemini config set extensions.firefly-iii-universal-bridge.settings.FIREFLY_URL "http://your-host:PORT"
gemini config set extensions.firefly-iii-universal-bridge.settings.FIREFLY_TOKEN "your_token"

See gemini.md for the full guide.


Docker (Official Image)

The official image is available on GitHub Packages: ghcr.io/fabianonetto/mcp-server-firefly-iii.

Run as a service (SSE Mode)

Ideal for ChatGPT Actions, Cursor (SSE), or custom integrations.

docker run -d \
  --name firefly-mcp \
  -p 3001:3001 \
  -e FIREFLY_URL="http://your-firefly-instance" \
  -e FIREFLY_TOKEN="your_personal_access_token" \
  -e PORT=3001 \
  ghcr.io/fabianonetto/mcp-server-firefly-iii:latest

Run with Claude Desktop (stdio Mode)

Add this to your claude_desktop_config.json:

{
  "mcpServers": {
    "firefly-iii": {
      "command": "docker",
      "args": [
        "run",
        "-i",
        "--rm",
        "-e", "FIREFLY_URL=http://your-host:PORT",
        "-e", "FIREFLY_TOKEN=your_token",
        "ghcr.io/fabianonetto/mcp-server-firefly-iii:latest"
      ]
    }
  }
}

Cursor / VS Code (MCP Extension)

Add to your MCP config (.cursor/mcp.json or equivalent):

{
  "mcpServers": {
    "firefly-iii": {
      "command": "node",
      "args": ["/absolute/path/to/mcp-server-firefly-iii/index.js"],
      "env": {
        "FIREFLY_URL": "http://your-host:PORT",
        "FIREFLY_TOKEN": "your_personal_access_token"
      }
    }
  }
}

HTTP Mode (Streamable HTTP, SSE, ChatGPT Actions, REST)

Start the server with a port to enable the MCP HTTP endpoints and REST API:

FIREFLY_URL=http://your-host:PORT FIREFLY_TOKEN=your_token PORT=3000 node index.js

Available endpoints:

Endpoint

Description

POST /mcp, GET /mcp, DELETE /mcp

Streamable HTTP transport (recommended for modern MCP clients like n8n)

GET /sse

Server-Sent Events (SSE) transport (supports multiple concurrent sessions & reconnects)

POST /messages

SSE message endpoint (routes by ?sessionId=...)

POST /api/<tool_name>

Direct REST call to any tool

GET /openapi.json

OpenAPI 3.0 spec (import into ChatGPT Actions)


Tool Categories

Category

Tools

Description

Core

1

System info & connectivity

Accounts

5

Full CRUD for all account types

Transactions

7

CRUD, split transactions, search

Budgets

8

Budgets + monetary limits

Bills & Piggy Banks

7

Bill tracking + savings goals

Automation

11

Rules, rule groups, webhooks

Recurring

5

Recurring transaction rules

System

8

Currencies + user preferences

Insights

7

Attachments, charts, net worth, spending

Meta

4

Categories + tags

Object Groups

2

Account/piggy bank organization

Admin

1

Data export

Total

66


Documentation

Document

Description

docs/API.md

Complete reference for all 66 tools and their input schemas

docs/PROMPTS.md

Prompt examples for common financial tasks

docs/USE_CASES.md

Strategic guides: tax assistant, subscription auditor, receipt manager

docs/TESTING.md

Test suite documentation (78 tests, all tools covered)

CLAUDE.md

Claude Code & Claude Desktop setup guide

gemini.md

Gemini CLI extension guide


Running Tests

npm test

78 tests covering all 66 tools. No live Firefly III instance required — all API calls are mocked. See docs/TESTING.md for details.


Security

  • Use a VPN or SSH tunnel if exposing the server to the internet.

  • Keep your FIREFLY_TOKEN secret. Never commit .mcp.json or .env files.

  • See SECURITY.md for the full security policy.


Roadmap

  • v1.x — Initial connectivity

  • v2.x — Exhaustive API coverage (CRUD & core admin)

  • v3.x — Power user features (splits, insights, automation)

  • v3.1.0 — Official Docker image & CI/CD

Available Tools

66 tools
create_accountC

Create a new account.

Inputs: name (required), type (required), account_role, currency_code, +4 more.

create_billC

Create a new bill.

Inputs: date (required), name (required), amount_max (required), amount_min (required), +1 more.

create_budgetC

Create a new budget.

Inputs: name (required).

create_budget_limitC

Set a monetary limit for a budget period.

Inputs: id (required), end (required), start (required), amount (required), +1 more.

create_categoryC

Create a new category.

Inputs: name (required).

create_currencyC

Store a new currency.

Inputs: code (required), name (required), symbol (required), decimal_places.

create_object_groupC

Create a new object group.

Inputs: title (required), order.

create_piggy_bankC

Create a new piggy bank.

Inputs: name (required), account_id (required), target_amount (required).

create_recurringC

Create a new recurring transaction rule.

Inputs: name (required), type (required), amount (required), repeat_freq (required), +2 more.

create_ruleC

Store a new rule.

Inputs: title (required), trigger (required), rule_group_id (required).

create_split_transactionB

Create a single transaction divided into multiple splits (e.g., one receipt with different categories).

Inputs: splits (required), group_title.

create_tagC

Create a new tag.

Inputs: tag (required).

create_transactionC

Create a simple withdrawal, deposit, or transfer.

Inputs: type (required), amount (required), description (required), source_name (required), +4 more.

create_webhookD

Create a webhook.

Inputs: url (required), title (required), trigger (required).

delete_accountC

Permanently delete an account.

Inputs: id (required).

delete_attachmentC

Delete an attachment.

Inputs: id (required).

delete_billC

Delete a bill.

Inputs: id (required).

delete_budgetC

Delete a budget.

Inputs: id (required).

delete_budget_limitC

Delete a budget limit.

Inputs: limit_id (required), budget_id (required).

delete_currencyC

Delete a currency.

Inputs: code (required).

delete_piggy_bankC

Delete a piggy bank.

Inputs: id (required).

delete_recurringC

Delete a recurring transaction rule.

Inputs: id (required).

delete_ruleD

Delete a rule.

Inputs: id (required).

delete_transactionC

Permanently delete a transaction.

Inputs: id (required).

delete_webhookC

Delete a webhook.

Inputs: id (required).

get_aboutB

Get system information from Firefly III.

Inputs: no named parameters.

get_accountA

Get a single account by ID.

Inputs: id (required).

get_account_overview_chartC

Get balance trend charts.

Inputs: end (required), start (required).

get_attachmentC

Get attachment metadata.

Inputs: id (required).

get_budgetC

Get a single budget by ID.

Inputs: id (required).

get_currencyA

Get a single currency by code.

Inputs: code (required).

get_net_worth_summaryB

Get pre-calculated net worth summary over time.

Inputs: end (required), start (required).

get_preferenceC

Get a specific preference.

Inputs: name (required).

get_recurringA

Get a single recurring transaction by ID.

Inputs: id (required).

get_ruleB

Get a single rule.

Inputs: id (required).

get_rule_groupB

Get a single rule group.

Inputs: id (required).

get_spending_summaryA

Get expense totals per category for a date range.

Inputs: end (required), start (required).

get_transactionA

Get a single transaction by ID.

Inputs: id (required).

list_accountsC

List all accounts.

Inputs: type.

list_attachmentsB

List all files.

Inputs: no named parameters.

list_billsB

List all bills.

Inputs: no named parameters.

list_budget_limitsB

List monetary limits for a budget.

Inputs: id (required).

list_budgetsA

List all budgets.

Inputs: no named parameters.

list_categoriesA

List all categories.

Inputs: no named parameters.

list_currenciesA

List all currencies.

Inputs: no named parameters.

list_object_groupsA

List all object groups (used for organizing accounts/piggy banks).

Inputs: no named parameters.

list_piggy_banksA

List all piggy banks.

Inputs: no named parameters.

list_preferencesB

List all user preferences.

Inputs: no named parameters.

list_recurringA

List all recurring transaction rules.

Inputs: no named parameters.

list_rule_groupsB

List all rule groups.

Inputs: no named parameters.

list_rulesA

List all automation rules.

Inputs: no named parameters.

list_tagsA

List all tags.

Inputs: no named parameters.

list_transactionsC

List recent transactions.

Inputs: limit.

list_webhooksB

List webhooks.

Inputs: no named parameters.

search_transactionsC

Search for transactions.

Inputs: query (required), limit.

trigger_exportC

Trigger a data export from Firefly III.

Inputs: end (required), start (required), type.

trigger_rule_groupC

Manually run rule group.

Inputs: id (required).

update_accountD

Update an existing account.

Inputs: id (required), name, active.

update_budgetC

Update a budget.

Inputs: id (required), name, active.

update_currencyC

Update an existing currency.

Inputs: code (required), enabled.

update_piggy_bankC

Add/remove money from goal.

Inputs: id (required), amount (required).

update_preferenceC

Update a specific preference.

Inputs: data (required), name (required).

update_recurringC

Update an existing recurring transaction.

Inputs: id (required), name, active.

update_ruleC

Update a rule.

Inputs: id (required), title.

update_transactionB

Update an existing transaction. Supports updating description, category_name, and other fields.

Inputs: id (required), tags, description, category_name.

upload_attachmentB

Upload a file and attach it to a Firefly III object (e.g. a transaction). Requires two steps internally: creates the attachment record, then uploads the file content.

Inputs: content (required), filename (required), attachable_id (required), attachable_type (required).

Tool Schema Changelog

Recent tool additions, removals, and schema changes observed during successful MCP inspections.

Loading tool schema changelog…

    TDQS

    C2.7/5.0

    Scored across 66 tools

    Disambiguation5/5

    Every tool maps to a distinct resource and action, and similar-sounding tools like get_account vs get_account_overview_chart are clearly separated by descriptions. Even create_transaction and create_split_transaction are differentiated as simple vs split creation.

    Naming Consistency5/5

    Tool names consistently follow a lowercase snake_case verb_noun pattern such as list_accounts, get_account, create_account, update_account, and delete_account. Minor exceptions like get_about and create_split_transaction do not undermine the overall predictable convention.

    Tool Count2/5

    With 66 tools, the surface is far too large for an AI-facing server; even though Firefly III has a broad API, this feels like an uncurated endpoint dump rather than a focused bridge. The volume creates significant context overhead and tool-selection burden for agents.

    Completeness2/5

    Core resources like accounts, transactions, budgets, rules, and recurring transactions have full CRUD coverage, but many secondary resources are notably incomplete: categories only have list/create, bills lack get/update, rule groups have no create/update/delete, and webhooks/object groups are partial. These gaps will cause frequent agent dead ends.

    Maintenance

    ActivityMaintained
    ResponsivenessLimited data

    Related MCP Connectors

    Related MCP Servers

    • -
      license
      Not graded
      quality
      Not graded
      maintenance
      Enables AI tools to interact with Firefly III personal finance management instances through a cloud-deployed MCP server. Supports financial operations like account management, transactions, budgeting, and reporting with configurable tool presets.
      22 npm
      -
    • F
      license
      Not graded
      quality
      D
      maintenance
      Enables AI assistants to interact with YNAB budgets through natural language. Supports managing accounts, categories, transactions, and budget months with 21 tools for comprehensive budget operations.
      -
    • A
      license
      Not graded
      quality
      Not graded
      maintenance
      Enables interaction with Firefly III personal finance management instances via the Firefly III API, deployed as a Cloudflare Worker. It allows AI tools to manage transactions, accounts, budgets, and reporting through natural language.
      22 npm
      ISC
    • A
      license
      A
      quality
      D
      maintenance
      Integrates with Firefly III personal finance software to enable natural language management of transactions, accounts, budgets, and categories. Supports recording expenses, checking balances, and organizing financial data through conversational AI.
      23
      12 npm
      MIT