Calebl Ynab MCP Server

🚀 ynab-mcp-server

ynab-mcp-server 是一個基於 mcp-framework 構建的模型上下文協議 (MCP) 服務器，專為 YNAB（You Need A Budget）預算工具打造。此 MCP 提供了與你在 https://ynab.com 上設置的 YNAB 預算進行交互的工具。

為了讓 AI 能夠與該工具交互，你需要獲取個人訪問令牌，獲取地址為：https://api.ynab.com/#personal-access-tokens。當將此 MCP 服務器添加到任何客戶端時，你需要提供個人訪問令牌作為 YNAB_API_TOKEN。請注意，此令牌絕不會直接發送給 LLM（大語言模型），它會安全地存儲在環境變量中，僅用於與 YNAB API 通信。

🚀 快速開始

1. 克隆倉庫：

git clone https://github.com/your-repository.git

2. 安裝依賴項：

npm install

3. 配置環境變量：

export YNAP_API_TOKEN=your_token_here

4. 運行服務器：

node dist/index.js

✨ 主要特性

• 提供與 YNAB 預算交互的工具，可通過 AI 對話與 YNAB 預算進行交互。
• 支持多種工作流程，如第一次設置、管理超支類別、添加新交易等。
• 提供豐富的工具列表，可對預算、類別等進行管理。

📦 安裝指南

指定環境變量

• YNAP_API_TOKEN（必需）：你的 YNAB 個人訪問令牌。
• KNOWLEDGE_DIR（可選）：知識文件存儲目錄，默認為服務器運行所在的 data 目錄。
• KNOWLEDGE_FILE（可選）：知識文件名，默認為 server-knowledge.json

📚 詳細文檔

項目目標

此項目旨在通過 AI 對話與你的 YNAB 預算進行交互，有幾個主要的工作流程需要實現。

工作流程

第一次設置

• 提示選擇你的預算，從你可用的預算中進行選擇。如果你在使用其他工具之前嘗試使用此工具，則會觸發此提示，要求你設置默認預算。
  • 需要的工具：ListBudgets、SetBudget

管理超支類別

添加新交易

批准交易

檢查總月度支出與總收入對比

根據類別目標自動分配資金

當前狀態

• 工具列表：
  • ListBudgets：列出所有預算
  • SetBudget：設置默認預算
  • GetCategories：獲取預算類別
  • CreateCategory：創建新預算類別
  • UpdateCategory：更新現有預算類別
  • DeleteCategory：刪除預算類別
• 下一步計劃：
  • 添加交易管理功能（CreateTransaction、UpdateTransaction、DeleteTransaction）
  • 實現預算跟蹤和報告

項目結構

.
├── src/
│   ├── tools/           # 工具目錄，包含與 YNAB API 交互的工具類
│   │   └── ynabTools.ts
│   └── server.ts       # 主服務器文件
├── package.json        # 項目依賴和腳本
└── README.md           # 項目文檔

添加組件

要添加新的功能模塊，可按以下步驟操作：

1. 在 src/tools/ 目錄下創建新工具類。
2. 實現與 YNAB API 的交互邏輯。
3. 更新服務器文件以加載新工具。

工具開發

工具的基本結構如下：

export class YNABTools {
    private readonly token: string;

    constructor(token: string) {
        this.token = token;
    }

    // 實現具體功能方法
}

發佈到 npm

1. 登錄到 npm：

npm login

2. 提交版本更新：

npm version patch

3. 發佈新版本：

npm publish

其他 MCP 客戶端

你可以訪問 https://modelcontextprotocol.io/clients 獲取更多信息。

學習更多

• MCP 框架 Github
• MCP 框架文檔