ynab-mcp-server

ynab-mcp-server

site icon
2025.04.15 1
TypeScript预算管理财务管理AI 对话金融服务
ynab-mcp-server 是一个基于 Model Context Protocol (MCP) 的服务,用于与 YNAB(You Need A Budget)预算工具进行交互。它允许用户通过 AI 对话管理个人预算,包括查看预算、添加交易、审批交易等功能。
View on GitHub

Overview

基本能力

产品定位

ynab-mcp-server 是一个用于与 YNAB 预算工具交互的 MCP 服务,旨在通过 AI 对话简化个人财务管理流程。

核心功能

  1. 预算管理:列出可用预算、设置默认预算、获取预算摘要。
  2. 交易管理:添加新交易、获取未审批的交易列表。
  3. 财务分析:检查月度总支出与总收入对比、自动分配资金到目标类别。

适用场景

  1. 个人财务管理:帮助用户管理预算、跟踪支出。
  2. 自动化财务操作:通过 AI 对话自动完成交易记录、预算调整等任务。

工具列表

  1. ListBudgets:列出用户账户中可用的预算。
  2. BudgetSummary:提供预算摘要,包括资金不足的类别和账户。
  3. GetUnapprovedTransactions:获取所有未审批的交易。
  4. CreateTransaction:为指定预算和账户创建交易。

常见问题解答

  1. 如何获取 YNAB API Token
  2. 从 YNAB 官网获取个人访问令牌:https://api.ynab.com/#personal-access-tokens。
  3. 如何设置默认预算
  4. 使用 ListBudgetsSetBudget 工具选择默认预算。

使用教程

使用依赖

  1. 确保已安装 Node.js 和 npm。
  2. 获取 YNAB API Token。

安装教程

# 安装依赖
npm install

# 构建项目
npm run build

调试方式

  1. 运行构建后的项目:
node dist/index.js
  1. 检查环境变量是否已正确设置(YNAP_API_TOKEN)。

项目结构

ynab-mcp-server/
├── src/
│   ├── tools/        # MCP Tools
│   └── index.ts      # Server entry point
├── package.json
└── tsconfig.json

添加组件

使用 YNAB SDK 和 OpenAPI 规范添加新工具:

# 添加新工具
mcp add tool my-tool

发布到 npm

  1. 更新 package.json
  2. 构建并测试:
npm run build
npm link
  1. 登录 npm 并发布:
npm login
npm publish

与 Claude Desktop 集成

  1. 添加配置到 Claude Desktop 配置文件:
{
  "mcpServers": {
    "ynab-mcp-server": {
      "command": "npx",
      "args": ["ynab-mcp-server"]
    }
  }
}

许可证

该项目遵循 MIT 开源许可条款,请参阅 MIT 了解完整条款。