Это сервер Model Context Protocol (MCP) для Firefly III, бесплатного персонального финансового менеджера с открытым исходным кодом. Через этот MCP-сервер пользователи могут использовать инструменты ИИ для управления своими учетными записями и транзакциями Firefly III, создавая помощников ИИ для личных финансов и бухгалтерского учета.

中中文版

Проектная структура

В этом проекте используется структура монорепо, управляемая Turborepo, содержащая следующие основные пакеты:

*@firefly-iii-mcp/core - базовый функциональный модуль, обеспечивающий основу для взаимодействия с API Firefly III @firefly-iii-mcp/local - инструмент командной строки для локального запуска MCP-сервера @firefly-iii-mcp/cloudflareworker - Внедрение для развертывания в Cloudflare Workers @firefly-iii-mcp/server - реализация серверов на основе экспресс-систем с поддержкой потокового HTTP и SSE

Особенности

Взаимодействие с экземплярами Firefly III через AI • Программное управление счетами и транзакциями

• Расширяемый набор инструментов для различных финансовых операций Поддержка локального и облачного развертывания Совместимость со стандартом Model Context Protocol
• Фильтрация инструментов через предустановленные или пользовательские теги для уменьшения использования токенов

Предпосылки

Бегущий экземпляр Firefly III

Firefly III MCP Server

This is a Model Context Protocol (MCP) server for Firefly III, a free and open-source personal finance manager. Through this MCP server, users can leverage AI tools to manage their Firefly III accounts and transactions, creating AI assistants for personal finance and accounting.

查看中文版

Project Structure

This project uses a Turborepo-managed monorepo structure, containing the following main packages:

• @firefly-iii-mcp/core - Core functionality module providing the foundation for interacting with the Firefly III API
• @firefly-iii-mcp/local - Command-line tool for running the MCP server locally
• @firefly-iii-mcp/cloudflare-worker - Implementation for deployment to Cloudflare Workers
• @firefly-iii-mcp/server - Express-based server implementation with Streamable HTTP and SSE support

Features

• Interact with Firefly III instances via AI
• Programmatically manage accounts and transactions
• Extensible toolset for various financial operations
• Support for both local and cloud deployment
• Compatible with the Model Context Protocol standard
• Tool filtering via presets or custom tags to reduce token usage

Prerequisites

• A running Firefly III instance
• A Cloudflare account if you plan to deploy using the “Deploy to Cloudflare” button

Getting Started

1. Obtain a Firefly III Personal Access Token (PAT)

To allow the MCP server to interact with your Firefly III instance, you need to generate a Personal Access Token (PAT):

1. Log in to your Firefly III instance
2. Navigate to Options > Profile > OAuth
3. Under the “Personal access tokens” section, click on “Create new token”
4. Give your token a descriptive name (e.g., “MCP Server Token”)
5. Click “Create”
6. Important: Copy the generated token immediately. You will not be able to see it again.

For more details, refer to the official Firefly III documentation on Personal Access Tokens.

2. Configure the MCP Server

You need to provide the Firefly III PAT and your Firefly III instance URL to the MCP server. This can be done in several ways:

Request Headers (Recommended)

Provide these values in the headers of each request to the MCP server. This is generally the most secure method:

• X-Firefly-III-Url: Your Firefly III instance URL (e.g., https://firefly.yourdomain.com)
• Authorization: The Personal Access Token, typically prefixed with Bearer (e.g., Bearer YOUR_FIREFLY_III_PAT)

Please consult the documentation of the AI tool or client you are using for the exact header names it expects.

Query Parameters (Use with caution)

Alternatively, you can provide these values in the query parameters of each request to the MCP server:

• baseUrl: Your Firefly III instance URL
• pat: Your Firefly III Personal Access Token