Package Exports

This package does not declare an exports field, so the exports above have been automatically detected and optimized by JSPM instead. If any package subpath is missing, it is recommended to post an issue to the original package (@firefly-iii-mcp/local) to support the "exports" field. If that is not possible, create a JSPM override to customize the exports field for this package.

Readme

Firefly III MCP Server - Local

This package provides a command-line tool for running the Firefly III MCP (Model Context Protocol) server locally. The MCP server integrates with Firefly III, a free and open-source personal finance manager.

查看中文版

Installation

# Install globally
npm install -g @firefly-iii-mcp/local

# Or use directly with npx
npx @firefly-iii-mcp/local --pat YOUR_PAT --baseUrl YOUR_FIREFLY_III_URL

Usage

To run the MCP server, you need to provide two required parameters:

FIREFLY_III_PAT: Personal Access Token for your Firefly III instance
FIREFLY_III_BASE_URL: URL of your Firefly III instance

You can provide these parameters in two ways:

1. Command-line arguments

firefly-iii-mcp --pat YOUR_PAT --baseUrl YOUR_FIREFLY_III_URL

2. Environment variables

Create a .env file with the following content:

FIREFLY_III_PAT=YOUR_PAT
FIREFLY_III_BASE_URL=YOUR_FIREFLY_III_URL

Then run:

firefly-iii-mcp

Integration with AI Tools

Once the MCP server is running, you can connect to it using MCP-compatible AI tools. For example, using supergateway:

npx -y supergateway --streamableHttp "stdio://"

This creates a gateway through which AI models can interact with your Firefly III instance.

Requirements

Node.js >= 20
A Firefly III instance with a valid personal access token

Development

This package is part of a monorepo managed with Turborepo. Please refer to the CONTRIBUTING.md file in the project root for detailed contribution guidelines.

License

This project is licensed under the MIT License.