Firefly III API + MCP Server + A2A Agent — personal finance manager
Project description
Firefly III MCP
CLI or API | MCP | Agent
Version: 0.1.0
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
actionargument, 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-utilitiesnative — 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
Install with uvx (no install — run on demand)
uvx --from firefly-iii-mcp firefly-iii-mcp # MCP server
uvx --from firefly-iii-mcp firefly-iii-agent # A2A agent server
Install with pip
python -m pip install firefly-iii-mcp # core (API client)
python -m pip install "firefly-iii-mcp[all]" # + MCP server + A2A agent + telemetry
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
Using as an MCP Server
The MCP Server can be run in stdio (local), streamable-http (networked), or
sse mode.
Environment Variables
FIREFLY_III_URL: The URL of the target service.FIREFLY_III_TOKEN: The API token or access token.
stdio Transport (local IDEs — Cursor, Claude Desktop, VS Code)
{
"mcpServers": {
"firefly-iii-mcp": {
"command": "uvx",
"args": ["--from", "firefly-iii-mcp", "firefly-iii-mcp"],
"env": {
"FIREFLY_III_URL": "https://service.example.com",
"FIREFLY_III_TOKEN": "your_token"
}
}
}
}
Streamable-HTTP Transport (networked / production)
{
"mcpServers": {
"firefly-iii-mcp": {
"command": "uvx",
"args": ["--from", "firefly-iii-mcp", "firefly-iii-mcp", "--transport", "streamable-http", "--port", "8000"],
"env": {
"TRANSPORT": "streamable-http",
"HOST": "0.0.0.0",
"PORT": "8000",
"FIREFLY_III_URL": "https://service.example.com",
"FIREFLY_III_TOKEN": "your_token"
}
}
}
}
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.jsonviauvx,docker run, orpodman run, or point at a local streamable-http container byurl. - Remote URL — connect to a server deployed behind Caddy at
http://firefly-iii-mcp.arpa/mcpusing 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
Release history Release notifications | RSS feed
Download files
Download the file for your platform. If you're not sure which to choose, learn more about installing packages.
Source Distribution
Built Distribution
Filter files by name, interpreter, ABI, and platform.
If you're not sure about the file name format, learn more about wheel file names.
Copy a direct link to the current filters
File details
Details for the file firefly_iii_mcp-0.1.0.tar.gz.
File metadata
- Download URL: firefly_iii_mcp-0.1.0.tar.gz
- Upload date:
- Size: 80.5 kB
- Tags: Source
- Uploaded using Trusted Publishing? No
- Uploaded via: twine/6.2.0 CPython/3.14.4
File hashes
| Algorithm | Hash digest | |
|---|---|---|
| SHA256 |
5051030c438df7959d4603c338558d881fe53a639bb66addbcafbab35eddc565
|
|
| MD5 |
734a2d6d165c5ae582833fed5d0ff301
|
|
| BLAKE2b-256 |
885574af9993a32e78b4839ada3707fe9f29ce00c70b3cf53825b390568993cb
|
File details
Details for the file firefly_iii_mcp-0.1.0-py3-none-any.whl.
File metadata
- Download URL: firefly_iii_mcp-0.1.0-py3-none-any.whl
- Upload date:
- Size: 119.6 kB
- Tags: Python 3
- Uploaded using Trusted Publishing? No
- Uploaded via: twine/6.2.0 CPython/3.14.4
File hashes
| Algorithm | Hash digest | |
|---|---|---|
| SHA256 |
4693d8b6aa40f9739c1453ed787ccf5b6db8c07563186a5ed386f6c56f861c41
|
|
| MD5 |
b7fa9bf093990b740d21e4c40a182723
|
|
| BLAKE2b-256 |
7885a74fd0acb9a2255a1ae74b2e9be2a4a49fad8b222500bcd305212edc2d04
|