Prompts API¶
Auto-generated API reference for MCP prompt functions. Prompts are organized into three modules: core prompts for everyday tasks, analysis prompts for data interpretation, and workflow guides for step-by-step processes.
Core Prompts¶
prompts
¶
MCP Prompt templates for common YNAB workflows.
Provides guided workflow instructions that help LLMs perform multi-step YNAB tasks efficiently. Each prompt references the specific MCP resources to read and tools to call.
Templates are loaded from .md files in the templates/prompts/ subpackage via importlib.resources.
ENTER_TRANSACTIONS_TEMPLATE
module-attribute
¶
resolve_step
¶
Return instruction to resolve budget via manage_budgets.
Returns:
-
str–Step text instructing LLM to resolve the budget ID.
prepend_resolve_step
¶
Prepend the budget resolution step and renumber existing steps.
When no budget_id is provided, the template needs a step 1 that instructs the LLM to resolve the budget ID first, with all existing steps renumbered starting from 2.
Parameters:
-
template(str) –The formatted template text (with {budget_id} still as a literal placeholder).
Returns:
-
str–Template text with resolve step prepended and steps renumbered.
Source code in src/ynaa_mcp/prompts.py
review_monthly_spending
¶
Guide the LLM through reviewing a month's spending.
Produces a step-by-step workflow that reads budget context via MCP resources, then uses tools to analyze spending.
Parameters:
-
month(str) –The month to review (YYYY-MM format).
-
budget_id(str | None, default:None) –Optional budget ID. If not provided, the LLM will be instructed to resolve it first.
Returns:
-
str–Guided workflow text for monthly spending review.
Source code in src/ynaa_mcp/prompts.py
enter_transactions
¶
Guide the LLM through entering transactions.
Produces a step-by-step workflow that reads account and category context, then walks through transaction entry.
Parameters:
-
budget_id(str | None, default:None) –Optional budget ID. If not provided, the LLM will be instructed to resolve it first.
Returns:
-
str–Guided workflow text for transaction entry.
Source code in src/ynaa_mcp/prompts.py
budget_health_check
¶
Guide the LLM through a budget health review.
Produces a step-by-step workflow that reads account and category data, then analyzes overall budget health.
Parameters:
-
budget_id(str | None, default:None) –Optional budget ID. If not provided, the LLM will be instructed to resolve it first.
Returns:
-
str–Guided workflow text for budget health review.
Source code in src/ynaa_mcp/prompts.py
Analysis Prompts¶
analysis
¶
MCP analysis prompt templates for YNAB budget analysis.
Provides 6 analysis prompts that guide LLMs through structured data interpretation workflows: budget health, spending trends, budget setup, debt payoff, savings goals, and income allocation.
Templates are loaded from .md files in the templates/analysis/ subpackage via importlib.resources.
BUDGET_SETUP_ADVISOR_TEMPLATE
module-attribute
¶
DEBT_PAYOFF_PLANNER_TEMPLATE
module-attribute
¶
SAVINGS_GOAL_TRACKER_TEMPLATE
module-attribute
¶
INCOME_ALLOCATION_TEMPLATE
module-attribute
¶
prepend_resolve_step
¶
Prepend the budget resolution step and renumber existing steps.
When no budget_id is provided, the template needs a step 1 that instructs the LLM to resolve the budget ID first, with all existing steps renumbered starting from 2.
Parameters:
-
template(str) –The formatted template text (with {budget_id} still as a literal placeholder).
Returns:
-
str–Template text with resolve step prepended and steps renumbered.
Source code in src/ynaa_mcp/prompts.py
budget_health_analysis
¶
Comprehensive budget health assessment.
Guides the LLM through checking TBB state, identifying overspending (cash vs credit), reviewing underfunded goals, and producing actionable improvement recommendations.
Parameters:
-
budget_id(str | None, default:None) –Optional budget ID. If not provided, the LLM will be instructed to resolve it first.
Returns:
-
str–Guided workflow text for budget health analysis.
Source code in src/ynaa_mcp/analysis.py
spending_trends
¶
Multi-month spending comparison and trend analysis.
Guides the LLM through fetching 3 months of transaction and category data, calculating month-over-month changes, and identifying categories with increasing or problematic trends.
Parameters:
-
budget_id(str | None, default:None) –Optional budget ID. If not provided, the LLM will be instructed to resolve it first.
Returns:
-
str–Guided workflow text for spending trend analysis.
Source code in src/ynaa_mcp/analysis.py
budget_setup_advisor
¶
First-time YNAB budget setup guidance.
Guides the LLM through creating accounts, organizing categories, performing initial budget allocation, and explaining the Four Rules in practical terms. Uses a supportive coaching tone.
Parameters:
-
budget_id(str | None, default:None) –Optional budget ID. If not provided, the LLM will be instructed to resolve it first.
Returns:
-
str–Guided workflow text for budget setup.
Source code in src/ynaa_mcp/analysis.py
debt_payoff_planner
¶
Debt elimination strategy planner.
Guides the LLM through identifying all debt accounts, presenting avalanche and snowball payoff strategies with trade-offs, and helping the user choose and implement a plan.
Parameters:
-
budget_id(str | None, default:None) –Optional budget ID. If not provided, the LLM will be instructed to resolve it first.
Returns:
-
str–Guided workflow text for debt payoff planning.
Source code in src/ynaa_mcp/analysis.py
savings_goal_tracker
¶
Savings goal progress monitoring.
Guides the LLM through listing all goals, calculating progress percentages, identifying underfunded goals, and creating prioritized funding recommendations.
Parameters:
-
budget_id(str | None, default:None) –Optional budget ID. If not provided, the LLM will be instructed to resolve it first.
Returns:
-
str–Guided workflow text for savings goal tracking.
Source code in src/ynaa_mcp/analysis.py
income_allocation
¶
YNAB priority-ordered income allocation guidance.
Guides the LLM through allocating new income following YNAB's recommended priority order: immediate obligations, true expenses, quality of life, and savings goals.
Parameters:
-
budget_id(str | None, default:None) –Optional budget ID. If not provided, the LLM will be instructed to resolve it first.
Returns:
-
str–Guided workflow text for income allocation.
Source code in src/ynaa_mcp/analysis.py
Workflow Guides¶
workflows
¶
MCP Prompt templates for YNAB workflow guides.
Provides step-by-step workflow guides that help LLMs coach users through common YNAB scenarios. Each prompt references specific MCP resources to read and tools to call, with a supportive coaching tone.
Templates are loaded from .md files in the templates/workflows/ subpackage via importlib.resources.
GETTING_OUT_OF_DEBT_TEMPLATE
module-attribute
¶
IRREGULAR_INCOME_TEMPLATE
module-attribute
¶
COUPLES_BUDGETING_TEMPLATE
module-attribute
¶
BREAKING_PAYCHECK_TO_PAYCHECK_TEMPLATE
module-attribute
¶
prepend_resolve_step
¶
Prepend the budget resolution step and renumber existing steps.
When no budget_id is provided, the template needs a step 1 that instructs the LLM to resolve the budget ID first, with all existing steps renumbered starting from 2.
Parameters:
-
template(str) –The formatted template text (with {budget_id} still as a literal placeholder).
Returns:
-
str–Template text with resolve step prepended and steps renumbered.
Source code in src/ynaa_mcp/prompts.py
_format_with_resolve
¶
Format a workflow template, inserting resolve step if needed.
Parameters:
-
template(str) –The template string with {budget_id} placeholders.
-
budget_id(str | None) –Optional budget ID. If None, a resolve step is prepended.
Returns:
-
str–The formatted workflow guide text.
Source code in src/ynaa_mcp/workflows.py
getting_started
¶
Walk a new user through creating their first YNAB budget.
Guides through account setup, category creation, and initial budget allocation with a supportive coaching tone.
Parameters:
-
budget_id(str | None, default:None) –Optional budget ID. If not provided, the LLM will be instructed to resolve it first.
Returns:
-
str–Step-by-step first budget creation guide.
Source code in src/ynaa_mcp/workflows.py
getting_out_of_debt
¶
Guide a user through building a debt payoff plan.
Covers debt inventory, avalanche vs snowball strategies, and setting up systematic payment workflows.
Parameters:
-
budget_id(str | None, default:None) –Optional budget ID. If not provided, the LLM will be instructed to resolve it first.
Returns:
-
str–Step-by-step debt payoff workflow guide.
Source code in src/ynaa_mcp/workflows.py
irregular_income
¶
Guide a freelancer or commission earner through income smoothing.
Covers the income buffer concept, monthly workflow for variable income, and handling feast/famine cycles.
Parameters:
-
budget_id(str | None, default:None) –Optional budget ID. If not provided, the LLM will be instructed to resolve it first.
Returns:
-
str–Step-by-step irregular income budgeting guide.
Source code in src/ynaa_mcp/workflows.py
couples_budgeting
¶
Guide a couple through setting up shared finances in YNAB.
Covers budget structure options, account setup for partners, fun money categories, and the budget meeting workflow.
Parameters:
-
budget_id(str | None, default:None) –Optional budget ID. If not provided, the LLM will be instructed to resolve it first.
Returns:
-
str–Step-by-step couples budgeting guide.
Source code in src/ynaa_mcp/workflows.py
emergency_fund
¶
Guide a user through building an emergency fund.
Covers target calculation, category and goal setup, funding strategy, and when to use vs replenish.
Parameters:
-
budget_id(str | None, default:None) –Optional budget ID. If not provided, the LLM will be instructed to resolve it first.
Returns:
-
str–Step-by-step emergency fund building guide.
Source code in src/ynaa_mcp/workflows.py
breaking_paycheck_to_paycheck
¶
Guide a user through aging their money past 30 days.
Covers the Age of Money concept, buffer building strategy, milestone tracking, and long-term maintenance.
Parameters:
-
budget_id(str | None, default:None) –Optional budget ID. If not provided, the LLM will be instructed to resolve it first.
Returns:
-
str–Step-by-step guide to breaking the paycheck-to-paycheck cycle.