FM

fabianonetto/mcp-server-firefly-iii

开发工具

本页由 AI 翻译,技术细节请以原文为准。 查看原文

24 stars 5 forks 质量 89 趋势 25MIT

Firefly III 个人理财管理器的通用 MCP 服务器

概览

一个专业级、AI无关的桥接器,提供全面的100% API覆盖,将AI助手连接到你的Firefly III个人理财实例。 涵盖所有主要的Firefly III功能:账户、交易、预算、账单、定期规则、自动化、洞察、附件、货币等。 - Node.js v18 或更高版本 - 运行 Firefly III 实例 - Firefly III 中的 A 实例(配置文件→ OAuth → 个人访问令牌 →创建新令牌) Claude Code 在项目目录中使用 .mcp.json 来配置 MCP 服务器。凭据会放在单独的 .env 文件里,所以配置文件里不会有秘密。 在仓库根(gitignored — 从未提交): 在仓库根(gitignored — 从未提交): 服务器会自动读取 .env 的凭证。.mcp.json 里没有秘密。 服务器会自动启动。Claude Code 会在首次启动时提示你批准(仅一次)。

概述(AI 翻译)

一个专业级、AI无关的桥接器,提供全面的100% API覆盖,将AI助手连接到你的Firefly III个人理财实例。

66个工具涵盖所有主要Firefly III功能:账户、交易、预算、账单、定期规则、自动化、洞察、附件、货币等。


兼容性

AI平台 协议 连接 设置指南
Claude代码 MCP(本地语) 标准 CLAUDE.md
Claude 桌面版 MCP(本地) 标准 CLAUDE.md
双子座CLI MCP扩展 标准 gemini.md
光标 / VS 代码MCP 标准还是 SSE 下面是手动设置
ChatGPT OpenAPI 动作 REST / JSON /openapi.json 端点
自定义应用 REST API HTTP /api/ 端点

安装

先决条件

  • Node.js v18或更高版本
  • 一个正在运行的Firefly III实例
  • 来自Firefly III的个人访问令牌 (OAuth 个人资料→ →个人访问令牌 →创建新令牌)

克隆并安装


按平台设置

克劳德代码(推荐)

Claude Code 在项目目录中使用 .mcp.json 来配置 MCP 服务器。

本页由 AI 翻译,技术细节请以原文为准。

README

以下为原文 README 节选,完整内容请查看原文。

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/ endpoints

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": {
在 GitHub 查看完整 README

安装

docker run -i --rm -e FIREFLY_URL=http://your-host:PORT -e FIREFLY_TOKEN=your_token ghcr.io/fabianonetto/mcp-server-firefly-iii:latest
新手?先看 mcpskill.org 教程 →

配置

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