Ynab MCP Server

🚀 ynab - mcp - server

ynab - mcp - server 是一個基於 mcp - framework 構建的 Model Context Protocol (MCP) 服務器。它提供了與 YNAB 預算交互的工具，YNAB 的具體網址為 https://ynab.com ，可助力 AI 與 YNAB 預算進行交互。

🚀 快速開始

為了讓 AI 能夠與該工具交互，您需要獲取個人訪問令牌，可從 YNAB 獲取：https://api.ynab.com/#personal-access-tokens 。在將此 MCP 服務器添加到任何客戶端時，您需要提供個人訪問令牌作為 YNAB_API_TOKEN。此令牌絕不會直接發送給 LLM，它以環境變量的形式私下存儲，僅用於調用 YNAB API。

✨ 主要特性

• 預算數據導入：從 YNAB 導入預算數據並解析成 MCP 兼容格式。
• 數據查詢：支持對預算數據進行復雜查詢，例如按類別、時間範圍等篩選。
• 操作反饋：根據用戶指令提供操作結果的即時反饋。

📦 安裝指南

安裝步驟

1. 克隆倉庫：

git clone https://github.com/your-repository.git
cd ynab-mcp-server

2. 安裝依賴：

npm install

3. 啟動服務器：

node dist/index.js

💻 使用示例

基礎用法

預算數據導入 (ynab.ts)

export async function fetchBudgetData(token: string, budgetId?: string) {
    // 實現從 YNAB 獲取預算數據的邏輯
}

數據查詢 (query.ts)

export interface QueryOptions {
    category?: string;
    startDate?: string;
    endDate?: string;
}

export async function queryData(options: QueryOptions) {
    // 實現複雜查詢邏輯
}

📚 詳細文檔

環境配置

指定環境變量：

• YNAB_API_TOKEN（必需）
• YNAB_BUDGET_ID（可選）

項目目標

該項目的目的是通過 AI 對話實現與個人 YNAB 預算的交互。以下是主要的工作流程：

工作流程

第一次設置

• 提示選擇您擁有的預算，如果使用其他工具之前未配置，則會自動引導完成。
• 環境變量中提供 YNAB_API_TOKEN 和 YNAB_BUDGET_ID。

項目結構

核心文件

• index.js：入口文件，負責初始化 MCP 服務器。
• config.js：配置環境變量和默認值。
• tools/：包含實現的具體工具模塊。

工具實現

預算數據導入 (ynab.ts)

export async function fetchBudgetData(token: string, budgetId?: string) {
    // 實現從 YNAB 獲取預算數據的邏輯
}

數據查詢 (query.ts)

export interface QueryOptions {
    category?: string;
    startDate?: string;
    endDate?: string;
}

export async function queryData(options: QueryOptions) {
    // 實現複雜查詢邏輯
}

部署與測試

本地開發

1. 修改工具代碼
2. 運行 npm run build 編譯
3. 啟動服務器，自動加載更新的工具

測試

• 確保所有 API 調用成功且返回正確數據。
• 驗證查詢功能是否按預期工作。

學習資源

• MCP 框架 GitHub
• MCP 框架文檔