Skip to main content

MCP server for Beancount Fava

Project description

Beancount Fava MCP Server

An MCP server to interface with Beancount Fava.

Installation

uvx beancount-fava-mcp@latest --fava-url=https://your-fava-instance/ledger-name

This is a beancount MCP that relies on a fava instance to provide the data instead of reading the beancount files directly. So this is allowed to be installed on a completely different machine than where your beancount files are stored.

It allows for simple authentication, but it is optional. You can set the following environment variables:

  • FAVA_URL: The URL of your Fava instance (overrides the --fava-url argument)
  • FAVA_USERNAME: The username to authenticate with
  • FAVA_PASSWORD: The password to authenticate with

Features

  • get_ledger_data(): List all ledger data including account names, tags, and links.
  • get_accounts(): Get the list of all accounts.
  • get_currencies(): Get the list of all currencies/commodities.
  • get_payees(): Get the list of all payees.
  • get_tags(): Get the list of all tags.
  • get_links(): Get the list of all links.
  • query_journal(account, time, tags, links, payee, narration, extra_filter): Filter journal entries.
  • run_bql(query): Execute raw Beancount Query Language queries.
  • add_transaction(date, payee, narration, postings, tags, links, metadata, flag): Add a new transaction entry. Note: Review the transaction details carefully before execution.

Future Plans

  • Support some kind of write access to the ledger so that you can add transactions easily via your mcp client. (add_transaction added but still WIP)

Usage

Can be used with Claude Desktop or other MCP clients.

Project details


Download files

Download the file for your platform. If you're not sure which to choose, learn more about installing packages.

Source Distribution

beancount_fava_mcp-0.1.1.tar.gz (11.1 kB view details)

Uploaded Source

Built Distribution

If you're not sure about the file name format, learn more about wheel file names.

beancount_fava_mcp-0.1.1-py3-none-any.whl (10.0 kB view details)

Uploaded Python 3

File details

Details for the file beancount_fava_mcp-0.1.1.tar.gz.

File metadata

  • Download URL: beancount_fava_mcp-0.1.1.tar.gz
  • Upload date:
  • Size: 11.1 kB
  • Tags: Source
  • Uploaded using Trusted Publishing? No
  • Uploaded via: twine/6.1.0 CPython/3.13.7

File hashes

Hashes for beancount_fava_mcp-0.1.1.tar.gz
Algorithm Hash digest
SHA256 be20d620a3c1443f442dd08bf8556fe743c47cb70aa21e4283bc6f5403945a5b
MD5 f8ceb68a67f1a0aac1238c4968c9af56
BLAKE2b-256 38b33a95aa50509cfc914016dbff1fb85b8a95e864597d9cc7e8033c567bfb2c

See more details on using hashes here.

File details

Details for the file beancount_fava_mcp-0.1.1-py3-none-any.whl.

File metadata

File hashes

Hashes for beancount_fava_mcp-0.1.1-py3-none-any.whl
Algorithm Hash digest
SHA256 d29ab41999a35db2ed3ae897fd6c2408a95c000ae1ee7b7e888aa3acea375abc
MD5 883da5b929d0f899ff3c1594c834e1ee
BLAKE2b-256 7ce2d0070f425b1463521cb5e146a1f39897ad214771465430268cd5c06de979

See more details on using hashes here.

Supported by

AWS Cloud computing and Security Sponsor Datadog Monitoring Depot Continuous Integration Fastly CDN Google Download Analytics Pingdom Monitoring Sentry Error logging StatusPage Status page