Skip to main content

Firefly III API + MCP Server + A2A Agent — personal finance manager

Project description

Firefly III MCP

CLI or API | MCP | Agent

PyPI - Version MCP Server PyPI - Downloads GitHub Repo stars PyPI - License GitHub last commit (by committer)

Version: 1.0.1

Documentation — Installation, deployment, usage across the API, CLI, and MCP interfaces, the integrated A2A agent server, and guidance for provisioning the backing platform are maintained in the official documentation.


Table of Contents


Overview

Firefly III MCP MCP Server + A2A Agent

Firefly III API + MCP Server + A2A Agent — personal finance manager

This repository is actively maintained - Contributions are welcome!

Key Features

  • Action-routed MCP tools — each domain is exposed as a single MCP tool that routes to many underlying operations via an action argument, keeping the tool surface small.
  • Three interfaces, one package — use it as a Python API client, an MCP server (stdio / streamable-http / sse), or a Pydantic-AI A2A agent.
  • agent-utilities native — built on the shared framework (auth, action router, telemetry, governance) for fleet consistency.
  • Per-tool toggles — enable or disable each tool domain with environment switches.
  • Enterprise-ready — OTEL/Langfuse telemetry and optional Eunomia access governance.

Available MCP Tools

Each tool is action-routed: pass an action and a JSON params_json payload. Tool domains can be toggled on or off with the listed environment variable. The table below is auto-generated from the live server by the mcp-readme-table pre-commit hook (python -m agent_utilities.mcp.readme_tools) — do not edit it by hand.

MCP Tool Toggle Env Var Description
about_operations ABOUTTOOL Manage Firefly III about operations. CONCEPT:FF-001
accounts_operations ACCOUNTSTOOL Manage Firefly III accounts operations. CONCEPT:FF-001
attachments_operations ATTACHMENTSTOOL Manage Firefly III attachments operations. CONCEPT:FF-001
autocomplete_operations AUTOCOMPLETETOOL Manage Firefly III autocomplete operations. CONCEPT:FF-001
available_budgets_operations AVAILABLE_BUDGETSTOOL Manage Firefly III available_budgets operations. CONCEPT:FF-001
bills_operations BILLSTOOL Manage Firefly III bills operations. CONCEPT:FF-001
budgets_operations BUDGETSTOOL Manage Firefly III budgets operations. CONCEPT:FF-001
categories_operations CATEGORIESTOOL Manage Firefly III categories operations. CONCEPT:FF-001
charts_operations CHARTSTOOL Manage Firefly III charts operations. CONCEPT:FF-001
configuration_operations CONFIGURATIONTOOL Manage Firefly III configuration operations. CONCEPT:FF-001
currencies_operations CURRENCIESTOOL Manage Firefly III currencies operations. CONCEPT:FF-001
currency_exchange_rates_operations CURRENCY_EXCHANGE_RATESTOOL Manage Firefly III currency_exchange_rates operations. CONCEPT:FF-001
data_operations DATATOOL Manage Firefly III data operations. CONCEPT:FF-001
insight_operations INSIGHTTOOL Manage Firefly III insight operations. CONCEPT:FF-001
links_operations LINKSTOOL Manage Firefly III links operations. CONCEPT:FF-001
object_groups_operations OBJECT_GROUPSTOOL Manage Firefly III object_groups operations. CONCEPT:FF-001
piggy_banks_operations PIGGY_BANKSTOOL Manage Firefly III piggy_banks operations. CONCEPT:FF-001
preferences_operations PREFERENCESTOOL Manage Firefly III preferences operations. CONCEPT:FF-001
recurrences_operations RECURRENCESTOOL Manage Firefly III recurrences operations. CONCEPT:FF-001
rule_groups_operations RULE_GROUPSTOOL Manage Firefly III rule_groups operations. CONCEPT:FF-001
rules_operations RULESTOOL Manage Firefly III rules operations. CONCEPT:FF-001
search_operations SEARCHTOOL Manage Firefly III search operations. CONCEPT:FF-001
summary_operations SUMMARYTOOL Manage Firefly III summary operations. CONCEPT:FF-001
tags_operations TAGSTOOL Manage Firefly III tags operations. CONCEPT:FF-001
transactions_operations TRANSACTIONSTOOL Manage Firefly III transactions operations. CONCEPT:FF-001
user_groups_operations USER_GROUPSTOOL Manage Firefly III user_groups operations. CONCEPT:FF-001
users_operations USERSTOOL Manage Firefly III users operations. CONCEPT:FF-001
webhooks_operations WEBHOOKSTOOL Manage Firefly III webhooks operations. CONCEPT:FF-001

28 action-routed tools (default MCP_TOOL_MODE=condensed). Each is enabled unless its toggle is set false; set MCP_TOOL_MODE=verbose (or both) for the 1:1 per-operation surface. Auto-generated — do not edit.

Installation

Pick the extra that matches what you want to run:

Extra Installs Use when
firefly-iii-mcp[mcp] Slim MCP server only (agent-utilities[mcp] — FastMCP/FastAPI) You only run the MCP server (smallest install / image)
firefly-iii-mcp[agent] Full agent runtime (agent-utilities[agent,logfire] — Pydantic AI + the epistemic-graph engine) You run the integrated agent
firefly-iii-mcp[all] Everything (mcp + agent + logfire) Development / both surfaces

Install with uvx (no install — run on demand)

uvx --from "firefly-iii-mcp[mcp]" firefly-iii-mcp      # MCP server
uvx --from "firefly-iii-mcp[agent]" firefly-iii-agent  # A2A agent server

Install with pip / uv

# MCP server only (recommended for tool hosting — slim deps)
uv pip install "firefly-iii-mcp[mcp]"

# Full agent runtime (Pydantic AI + epistemic-graph engine)
uv pip install "firefly-iii-mcp[agent]"

# Everything (development)
uv pip install "firefly-iii-mcp[all]"      # or: python -m pip install "firefly-iii-mcp[all]"

Container images (:mcp vs :agent)

One multi-stage docker/Dockerfile builds two right-sized images, selected by --target:

Image tag Build target Contents Entrypoint
knucklessg1/firefly-iii-mcp:mcp --target mcp firefly-iii-mcp[mcp]slim, no engine/pydantic-ai/dspy/llama-index/tree-sitter firefly-iii-mcp
knucklessg1/firefly-iii-mcp:latest --target agent (default) firefly-iii-mcp[agent]full agent runtime + epistemic-graph engine firefly-iii-agent
docker build --target mcp   -t knucklessg1/firefly-iii-mcp:mcp    docker/   # slim MCP server
docker build --target agent -t knucklessg1/firefly-iii-mcp:latest docker/   # full agent

docker/mcp.compose.yml runs the slim :mcp server; docker/agent.compose.yml runs the agent (:latest) with a co-located :mcp sidecar.

Knowledge-graph database (epistemic-graph)

The full agent ([agent] / :latest) embeds the epistemic-graph engine (pulled in transitively via agent-utilities[agent]). For production — or to share one knowledge graph across multiple agents — run epistemic-graph as its own database container and point the agent at it instead of embedding it. Deployment recipes (single-node + Raft HA), connection config, and the full database architecture (with diagrams) are documented in the epistemic-graph deployment guide. The slim [mcp] server does not require the database.

Console scripts

After installation the following entry points are available on your PATH:

Command Description
firefly-iii-mcp Launch the MCP server
firefly-iii-agent Launch the A2A agent server

Usage

As a Python API client

from firefly_iii_mcp.auth import get_client

client = get_client()
status = client.get_system_status()
print(status)

As an MCP server (CLI)

# Local stdio (for IDEs)
firefly-iii-mcp

# Networked streamable-http
firefly-iii-mcp --transport streamable-http --host 0.0.0.0 --port 8000

Calling an MCP tool

Tools are action-routed — pass an action plus a JSON params_json string:

{
  "tool": "system_operations",
  "arguments": {
    "action": "status",
    "params_json": "{}"
  }
}

MCP

Install the slim [mcp] extra. All MCP examples below install firefly-iii-mcp[mcp] — the MCP-server extra that pulls only the FastMCP / FastAPI tooling (agent-utilities[mcp]). It deliberately excludes the heavy agent runtime (the epistemic-graph engine, pydantic-ai, dspy, llama-index, tree-sitter), so uvx/container installs are dramatically smaller and faster. Use the full [agent] extra only when you need the integrated Pydantic AI agent (see Installation).

MCP Configuration Examples

Install the slim [mcp] extra. All examples install firefly-iii-mcp[mcp] — the MCP-server extra that pulls only the FastMCP / FastAPI tooling (agent-utilities[mcp]). It deliberately excludes the heavy agent runtime (pydantic-ai, the epistemic-graph engine, dspy, llama-index), so uvx / container installs are far smaller. Use the full [agent] extra only when you need the integrated Pydantic AI agent.

stdio Transport (local IDEs — Cursor, Claude Desktop, VS Code)

{
  "mcpServers": {
    "firefly-iii-mcp": {
      "command": "uvx",
      "args": [
        "--from",
        "firefly-iii-mcp[mcp]",
        "firefly-iii-mcp"
      ],
      "env": {
        "MCP_TOOL_MODE": "condensed",
        "ABOUTTOOL": "True",
        "ACCOUNTSTOOL": "True",
        "ATTACHMENTSTOOL": "True",
        "AUTOCOMPLETETOOL": "True",
        "AVAILABLE_BUDGETSTOOL": "True",
        "BILLSTOOL": "True",
        "BUDGETSTOOL": "True",
        "CATEGORIESTOOL": "True",
        "CHARTSTOOL": "True",
        "CONFIGURATIONTOOL": "True",
        "CURRENCIESTOOL": "True",
        "CURRENCY_EXCHANGE_RATESTOOL": "True",
        "DATATOOL": "True",
        "FIREFLY_III_TOKEN": "your_token_here",
        "FIREFLY_III_URL": "http://localhost:8080",
        "INSIGHTTOOL": "True",
        "LINKSTOOL": "True",
        "OBJECT_GROUPSTOOL": "True",
        "PIGGY_BANKSTOOL": "True",
        "PREFERENCESTOOL": "True",
        "RECURRENCESTOOL": "True",
        "RULESTOOL": "True",
        "RULE_GROUPSTOOL": "True",
        "SEARCHTOOL": "True",
        "SUMMARYTOOL": "True",
        "TAGSTOOL": "True",
        "TRANSACTIONSTOOL": "True",
        "USERSTOOL": "True",
        "USER_GROUPSTOOL": "True",
        "WEBHOOKSTOOL": "True"
      }
    }
  }
}

Streamable-HTTP Transport (networked / production)

{
  "mcpServers": {
    "firefly-iii-mcp": {
      "command": "uvx",
      "args": [
        "--from",
        "firefly-iii-mcp[mcp]",
        "firefly-iii-mcp",
        "--transport",
        "streamable-http",
        "--port",
        "8000"
      ],
      "env": {
        "TRANSPORT": "streamable-http",
        "HOST": "0.0.0.0",
        "PORT": "8000",
        "MCP_TOOL_MODE": "condensed",
        "ABOUTTOOL": "True",
        "ACCOUNTSTOOL": "True",
        "ATTACHMENTSTOOL": "True",
        "AUTOCOMPLETETOOL": "True",
        "AVAILABLE_BUDGETSTOOL": "True",
        "BILLSTOOL": "True",
        "BUDGETSTOOL": "True",
        "CATEGORIESTOOL": "True",
        "CHARTSTOOL": "True",
        "CONFIGURATIONTOOL": "True",
        "CURRENCIESTOOL": "True",
        "CURRENCY_EXCHANGE_RATESTOOL": "True",
        "DATATOOL": "True",
        "FIREFLY_III_TOKEN": "your_token_here",
        "FIREFLY_III_URL": "http://localhost:8080",
        "INSIGHTTOOL": "True",
        "LINKSTOOL": "True",
        "OBJECT_GROUPSTOOL": "True",
        "PIGGY_BANKSTOOL": "True",
        "PREFERENCESTOOL": "True",
        "RECURRENCESTOOL": "True",
        "RULESTOOL": "True",
        "RULE_GROUPSTOOL": "True",
        "SEARCHTOOL": "True",
        "SUMMARYTOOL": "True",
        "TAGSTOOL": "True",
        "TRANSACTIONSTOOL": "True",
        "USERSTOOL": "True",
        "USER_GROUPSTOOL": "True",
        "WEBHOOKSTOOL": "True"
      }
    }
  }
}

Alternatively, connect to a pre-deployed Streamable-HTTP instance by url:

{
  "mcpServers": {
    "firefly-iii-mcp": {
      "url": "http://localhost:8000/firefly-iii-mcp/mcp"
    }
  }
}

Deploying the Streamable-HTTP server via Docker:

docker run -d \
  --name firefly-iii-mcp-mcp \
  -p 8000:8000 \
  -e TRANSPORT=streamable-http \
  -e HOST=0.0.0.0 \
  -e PORT=8000 \
  -e MCP_TOOL_MODE=condensed \
  -e ABOUTTOOL=True \
  -e ACCOUNTSTOOL=True \
  -e ATTACHMENTSTOOL=True \
  -e AUTOCOMPLETETOOL=True \
  -e AVAILABLE_BUDGETSTOOL=True \
  -e BILLSTOOL=True \
  -e BUDGETSTOOL=True \
  -e CATEGORIESTOOL=True \
  -e CHARTSTOOL=True \
  -e CONFIGURATIONTOOL=True \
  -e CURRENCIESTOOL=True \
  -e CURRENCY_EXCHANGE_RATESTOOL=True \
  -e DATATOOL=True \
  -e FIREFLY_III_TOKEN=your_token_here \
  -e FIREFLY_III_URL=http://localhost:8080 \
  -e INSIGHTTOOL=True \
  -e LINKSTOOL=True \
  -e OBJECT_GROUPSTOOL=True \
  -e PIGGY_BANKSTOOL=True \
  -e PREFERENCESTOOL=True \
  -e RECURRENCESTOOL=True \
  -e RULESTOOL=True \
  -e RULE_GROUPSTOOL=True \
  -e SEARCHTOOL=True \
  -e SUMMARYTOOL=True \
  -e TAGSTOOL=True \
  -e TRANSACTIONSTOOL=True \
  -e USERSTOOL=True \
  -e USER_GROUPSTOOL=True \
  -e WEBHOOKSTOOL=True \
  knucklessg1/firefly-iii-mcp:mcp

Auto-generated from the code-read env surface (MCP_TOOL_MODE + package vars) — do not edit.

Additional Deployment Options

firefly-iii-mcp can also run as a local container (Docker / Podman / uv) or be consumed from a remote deployment. The Deployment guide has full, copy-paste mcp_config.json for all four transports — stdio, streamable-http, local container / uv, and remote URL:

  • Local container / uv — launch the server from mcp_config.json via uvx, docker run, or podman run, or point at a local streamable-http container by url.
  • Remote URL — connect to a server deployed behind Caddy at http://firefly-iii-mcp.arpa/mcp using the "url" key.

Install Python Package

python -m pip install firefly-iii-mcp

Documentation

Full documentation is published to the GitHub Pages site and mirrored under docs/:

Project details


Download files

Download the file for your platform. If you're not sure which to choose, learn more about installing packages.

Source Distribution

firefly_iii_mcp-1.0.1.tar.gz (83.1 kB view details)

Uploaded Source

Built Distribution

If you're not sure about the file name format, learn more about wheel file names.

firefly_iii_mcp-1.0.1-py3-none-any.whl (120.5 kB view details)

Uploaded Python 3

File details

Details for the file firefly_iii_mcp-1.0.1.tar.gz.

File metadata

  • Download URL: firefly_iii_mcp-1.0.1.tar.gz
  • Upload date:
  • Size: 83.1 kB
  • Tags: Source
  • Uploaded using Trusted Publishing? No
  • Uploaded via: twine/6.2.0 CPython/3.14.4

File hashes

Hashes for firefly_iii_mcp-1.0.1.tar.gz
Algorithm Hash digest
SHA256 a850c51cf52ecbe2bf3ccccc3438e2d4ee9259cb05bd4401d5f64e8476ef7245
MD5 ab280d01a891ea246a27f102bf84eb19
BLAKE2b-256 2d43de1b1c5dac97b52a9abfb02e7c7949a310a20d6023d646686514ec6a0504

See more details on using hashes here.

File details

Details for the file firefly_iii_mcp-1.0.1-py3-none-any.whl.

File metadata

File hashes

Hashes for firefly_iii_mcp-1.0.1-py3-none-any.whl
Algorithm Hash digest
SHA256 ecc1e263b94eab9690a7d316a583f239c01ced386f44ca6440c635dd00518da5
MD5 bd26eb7507391a5a0189ae772fb4e66d
BLAKE2b-256 a6213b46d635449b6b145cf3ef900101ce359b707d5cd6210c23a65fe11691c0

See more details on using hashes here.

Supported by

AWS Cloud computing and Security Sponsor Datadog Monitoring Depot Continuous Integration Fastly CDN Google Download Analytics Pingdom Monitoring Sentry Error logging StatusPage Status page