Skip to main content

A Model Context Protocol server for interacting with YNAB

Project description

YNAB MCP Server

A Model Context Protocol (MCP) server for interacting with YNAB (You Need A Budget) via their API.

Features

  • Get budgets, accounts, and categories
  • Get, create and update transactions
  • Create new categories
  • Update budgeted amounts for categories
  • Get budget summaries

Prerequisites

  • Python 3.13 or higher
  • A YNAB account with an API token (Get your token here)
  • UV package manager (optional but recommended)

Installation

  1. Clone this repository

    git clone https://github.com/ntdef/ynab-mcp.git
    cd ynab-mcp
    
  2. Create a virtual environment

    uv venv
    
  3. Activate the virtual environment

    • Windows:
      venv\Scripts\activate
      
    • Unix/MacOS:
      source venv/bin/activate
      
  4. Install dependencies using UV

    # python -m pip install uv
    uv sync
    
  5. Copy .env.example to .env and add your YNAB API token

    cp .env.example .env
    # Edit .env with your favorite editor
    

Usage

Running the server

uv run ynab-mcp

The server will start in stdio mode, so you won't see any output.

Available tools

The YNAB MCP Server provides the following tools:

Budget management

  • get_budgets: Retrieve all budgets for the authenticated user
  • get_budget_summary: Get a summary of the budget, optionally for a specific month

Account management

  • get_accounts: Retrieve all accounts for a specific budget

Category management

  • get_categories: Retrieve all categories for a specific budget
  • create_category: Create a new category in the specified budget group
  • update_category_budgeted: Update the budgeted amount for a category in a specific month

Transaction management

  • get_transactions: Retrieve transactions for a specific budget, optionally filtered by date, account, or category
  • create_transaction: Create a new transaction in the specified budget
  • update_transaction: Update one or more fields of a specific transaction

Development

Running tests

uv run pytest

Code style

This project uses Black and isort for code formatting. To format your code:

uv run isort src tests
uv run black src tests

License

MIT License

Acknowledgements

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

ynab_mcp-0.1.3.tar.gz (24.8 kB view details)

Uploaded Source

Built Distribution

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

ynab_mcp-0.1.3-py3-none-any.whl (8.2 kB view details)

Uploaded Python 3

File details

Details for the file ynab_mcp-0.1.3.tar.gz.

File metadata

  • Download URL: ynab_mcp-0.1.3.tar.gz
  • Upload date:
  • Size: 24.8 kB
  • Tags: Source
  • Uploaded using Trusted Publishing? No
  • Uploaded via: uv/0.8.23

File hashes

Hashes for ynab_mcp-0.1.3.tar.gz
Algorithm Hash digest
SHA256 601c9a12e4dcc6a76e5048a9263c7dc37c898b3f5a991dfe6bbc9b70e04cf660
MD5 faaae6f21d97445d3ad9bab845f51b1d
BLAKE2b-256 d218448084b25f522c5654ede78acc3efa22fd1c4d4aba861bd850112e064203

See more details on using hashes here.

File details

Details for the file ynab_mcp-0.1.3-py3-none-any.whl.

File metadata

  • Download URL: ynab_mcp-0.1.3-py3-none-any.whl
  • Upload date:
  • Size: 8.2 kB
  • Tags: Python 3
  • Uploaded using Trusted Publishing? No
  • Uploaded via: uv/0.8.23

File hashes

Hashes for ynab_mcp-0.1.3-py3-none-any.whl
Algorithm Hash digest
SHA256 da836072ae181718be1ebcebd19530435909da6fc197dedba8fa18ccb06b79dc
MD5 ff9efe7cfe76466f41c2a12320802a77
BLAKE2b-256 a9907b2705268dc59e5690f17e9ea6e68f4f12eb207b146d87a9af798696e208

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