Skip to content

Getting Started

fireflyiii-mcp is an MCP (Model Context Protocol) server that bridges any MCP-compatible AI assistant to your Firefly III personal finance instance.

Prerequisites

  • A running Firefly III instance (self-hosted or cloud)
  • An MCP-compatible AI client (Claude Code, Claude Desktop, or other)
  • Node.js 20+ (for npm setups) or Docker (for the container setup)

Choose your setup

MethodTransportBest for
npm — stdiostdioSimplest. AI client and server on the same machine.
npm — HTTP/OAuthHTTP + OAuth 2.0AI client connecting remotely, prefers OAuth over a PAT.
Docker — HTTPHTTP + OAuth 2.0Self-hosted on a home lab or server.
Git checkoutstdio or HTTPContributing or local development.

Not sure which to pick? Start with npm — stdio — it's one config block and requires no server setup.

Nightly builds

Want to test unreleased changes from main? Install a nightly build via the @nightly (npm) or :nightly (Docker) tag. Nightlies are unstable — a normal install always gives you the latest tagged release.

How it works

The server exposes Firefly III's REST API as MCP tools. Your AI assistant calls these tools automatically when you ask finance-related questions. You never write API calls manually.

With 140 tools across 14 groups, you can optionally load only a subset to save context window space — see Tool filtering.

Released under the MIT License.