MCP YNAB Server 💰

MCP YNAB 服务 💰

欢迎使用 YNAB 的 MCP 服务（TypeScript 版本）！🎉 本项目可让你将 Cursor（或其他 MCP 客户端）连接到你的 You Need A Budget（YNAB）账户，直接在编辑器中与财务数据交互。

1. 这是什么？🤔（用途）

这是一个用 TypeScript 实现的 Model Context Protocol（MCP），可作为通往 YNAB 官方 API 的桥梁。其目标是在兼容 MCP 的环境中提供标准化工具，用于读取和写入 YNAB 数据，让 Cursor 等 AI 助手帮助你管理财务。

2. 可用工具 🛠️

此服务提供以下工具，每个工具都有自己的详细文档：

• listBudgets：列出你可用的预算。
• listAccounts：列出指定预算中的账户。
• getAccountBalance：获取指定账户的当前余额。
• listCategories：列出指定预算中的类别。
• getCategoryInfo：获取指定月份中特定类别的详细信息。
• getBudgetSummary：提供指定月份的预算摘要（收入、预算金额、活动）。
• listTransactions：列出预算中的交易，并提供筛选选项（按账户、类别、日期等）。
• createTransaction：在预算中创建新交易或拆分交易。

有关参数、输出和使用场景的详细信息，请参阅各工具的 README.md。

3. 设置 🚀

1. 克隆仓库：

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

2. 安装依赖：

   npm install
   

3. 配置 YNAB API 令牌： 你需要一个 YNAB 的个人访问令牌。对于 Cursor 集成，推荐且经过测试的方法是：

   • 编辑 Cursor 全局配置文件 ~/.cursor/mcp.json。
   • 添加或修改 mcp-ynab 条目，确保 command、args、cwd 和 env 配置正确：

     {
       "mcpServers": {
         // ... other servers ...
         "mcp-ynab": {
           "command": "node",
           // 👇 Path to the compiled script
           "args": ["<path-to-your-project>/mcp-ynab/dist/server.js"], 
           "cwd": "<path-to-your-project>/mcp-ynab", // Path to this project
           "enabled": true,
           "env": {
             // 👇 Your YNAB token here, with the correct name!
             "YNAB_API_TOKEN": "YOUR_YNAB_TOKEN_HERE" 
           }
         }
         // ... other servers ...
       }
     }
     

   • 另一种方法（需要修改代码）： 你可以在项目根目录中使用 .env 文件，但需要取消注释 src/server.ts 中的 dotenv 逻辑，并确保它不会干扰服务模式。

4. 编译代码：

   npm run build
   

4. 在 Cursor 中使用 💡

1. 确保 ~/.cursor/mcp.json 中的配置正确，且 "enabled": true。
2. 重启 Cursor，以加载更新后的配置并启动服务。
3. 完成！在 Cursor 的 MCP 设置中，你应该能看到带有绿点的 mcp-ynab，以及可用工具列表。
4. 现在你可以让 AI 助手使用这些工具：
   • “列出我的 YNAB 预算”
   • “使用 mcp_ynab_list_accounts，预算 ID 为 'last-used'”
   • “我的账户 X（ID：YYY）在预算 Z 中的余额是多少？”（可能会使用 mcp_ynab_get_account_balance）

5. 开发 🧑‍💻

• 在开发模式下运行服务（支持热重载）： npm run dev
• 运行测试： npm test
• 编译用于生产环境/MCP： npm run build
• CLI 模式（已注释）： 在 src/server.ts 中，运行 node dist/server.js list-budgets 等命令的逻辑已被注释，因为它会干扰 Cursor 的 MCP 服务模式。如有需要，你可以取消注释以进行本地测试，但请记得在与 Cursor 集成前重新注释并重新编译。

---