MCP Ynab

🚀 MCP Budget Assistant Server 💰

Welcome to the MCP server for YNAB (TypeScript version)! 🎉 This project allows you to connect Cursor (or other MCP clients) to your You Need A Budget (YNAB) account, enabling you to interact with your financial data directly from your editor.

🚀 Quick Start

Prerequisites

This server requires a TypeScript implementation based on the Model Context Protocol (MCP) and serves as a bridge to the official YNAB API.

Installation

1. Clone the repository:

   # If you haven't cloned it yet
   git clone https://github.com/Bulletninja/mcp-ynab
   cd mcp-ynab
   

2. Install dependencies:

   npm install
   

3. Configure the YNAB API token:

   • Add your YNAB API token to the config.json file:

     {
       "ynabToken": "your_ynab_api_token_here"
     }
     

4. Start the server:

   npm start
   

Usage

Enable the MCP server in Cursor

1. Open the config.json file.
2. Add the following configuration:

   {
     "mcpServers": [
       {
         "name": "YNAB",
         "executablePath": "dist/server.js"
       }
     ]
   }
   

3. Start Cursor, and the server will run in the background.

Call tools

Enter the following command in the terminal to call a tool:

node dist/server.js [tool name]
For example:
node dist/server.js list-budgets

✨ Features

This server provides the following tools, each with detailed documentation:

• : List your available budgets.
• : List accounts within a specified budget.
• : Get the current balance of a specific account.
• : List categories within a specified budget.
• : Get detailed information about a specific category for a particular month.
• : Provide a budget summary (income, budgeted amount, activity) for a specific month.
• : List budget transactions with filtering options (by account, category, date, etc.).
• : Create a new transaction or entry in the budget.

Check the README.md for each tool for detailed information, including parameters, output, and usage context.

📚 Documentation

What is this? 🤔 (Purpose)

This is a TypeScript implementation based on the Model Context Protocol (MCP), serving as a bridge to the official YNAB API. The goal is to provide standardized tools for MCP-compatible environments to read and write YNAB data from AI assistants (such as Cursor) to help you manage your finances.

🔧 Technical Details

Development Information