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.0.5.tar.gz (11.5 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.0.5-py3-none-any.whl (9.8 kB view details)

Uploaded Python 3

File details

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

File metadata

  • Download URL: beancount_fava_mcp-0.0.5.tar.gz
  • Upload date:
  • Size: 11.5 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.0.5.tar.gz
Algorithm Hash digest
SHA256 bb2e814fadd4a2d262e94bcc06aa4e1498c6d9c2ec07f99bb90cc31c4ee50be1
MD5 be01bb32312bae1b1ec1f3becb2ac5c7
BLAKE2b-256 507c039c5d950a9ebcea976a501caffc1a22d69efe4bf840b3da3e9cbd77f9c1

See more details on using hashes here.

File details

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

File metadata

File hashes

Hashes for beancount_fava_mcp-0.0.5-py3-none-any.whl
Algorithm Hash digest
SHA256 a56e9a462d53d287d510eee7645d4d5b8c750c6b15adf0a644ade3b6ef9ba8ef
MD5 e32ef79a9c6496e5d8b8792b9ad49e89
BLAKE2b-256 2c18cf8f40228ab26701c21313503882eb65b0b14daae361e7ed33302636534e

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