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.0.tar.gz (10.4 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.0-py3-none-any.whl (9.9 kB view details)

Uploaded Python 3

File details

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

File metadata

  • Download URL: beancount_fava_mcp-0.1.0.tar.gz
  • Upload date:
  • Size: 10.4 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.0.tar.gz
Algorithm Hash digest
SHA256 4a92a28b96752b077b98338e3535f4991d266d1110751036f2efef173e8f805e
MD5 6ec6ff1f7ef303c328d46834c45e70af
BLAKE2b-256 bde7b35a82c222770c12d6144a124edae799e4706395efe8ad28791dfae11133

See more details on using hashes here.

File details

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

File metadata

File hashes

Hashes for beancount_fava_mcp-0.1.0-py3-none-any.whl
Algorithm Hash digest
SHA256 ee517d7ca241a0efcce55609f33b1e14d5b62f0775f5c5b1c49064be40240306
MD5 8bb86fdabbacbad369881d1d23c68dc2
BLAKE2b-256 0cf36c1ed18c66ba1ded523e1c3fc128a2ae7179e68ea96b7ab062261d62a8b4

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