使用说明

项目简介

ynab-mcp-server 是一个 Model Context Protocol (MCP) 服务器，它扩展了大型语言模型 (LLM) 的能力，使其能够与您的 YNAB (You Need A Budget) 预算进行交互。通过提供一系列工具，这个服务器允许您使用自然语言指令，通过支持 MCP 协议的客户端（如 Claude Desktop）来查询预算信息、管理未批准的交易以及创建新的交易记录。

主要功能点

预算列表查询: 列出您在 YNAB 中创建的所有预算，方便您选择需要操作的预算。
预算概览: 获取指定月份的预算摘要，重点展示超支类别和结余良好的类别，帮助您快速了解预算状况。
未批准交易查询: 检索所有未批准的交易记录，方便您审核和管理待处理的财务事项。
创建交易: 在指定的预算和账户中创建新的交易记录，使您可以通过 AI 助手快速录入消费或收入信息。

安装步骤

安装依赖: 首先确保您已安装 Node.js 和 npm。克隆仓库到本地后，在项目根目录下运行 'npm install' 命令安装项目依赖。
```
npm install
```
构建项目: 安装依赖完成后，运行 'npm run build' 命令编译 TypeScript 代码，生成可执行的 JavaScript 文件。
```
npm run build
```

服务器配置

要将此 MCP 服务器与 MCP 客户端连接，您需要在客户端的配置文件中添加服务器配置信息。以下是 Claude Desktop 客户端的配置示例。

本地开发配置 (需要绝对路径):

{
  "mcpServers": {
    "ynab-mcp-server": {
      "command": "node",
      "args": ["/absolute/path/to/ynab-mcp-server/dist/index.js"]
    }
  }
}

注意: 请将 '/absolute/path/to/ynab-mcp-server' 替换为您本地 'ynab-mcp-server' 仓库 'dist/index.js' 文件的绝对路径。

发布后使用 'npx' 启动:

{
  "mcpServers": {
    "ynab-mcp-server": {
      "command": "npx",
      "args": ["ynab-mcp-server"]
    }
  }
}

环境变量配置: 在启动服务器之前，您需要设置以下环境变量：

'YNAB_API_TOKEN': (必需) 您的 YNAB 个人访问令牌。请访问 https://api.ynab.com/#personal-access-tokens 获取。
'YNAB_BUDGET_ID': (可选) 默认预算 ID。如果您设置此变量，工具将默认使用此预算 ID。否则，您需要在每次调用工具时指定预算 ID。

基本使用方法

启动服务器: 在项目根目录下，运行 'node dist/index.js' 或 'npx ynab-mcp-server' (如果已发布并全局安装)。
配置 MCP 客户端: 将上述服务器配置 JSON 添加到您的 MCP 客户端配置文件中。
使用 AI 助手: 在您的 MCP 客户端中，即可通过自然语言指令调用 YNAB MCP 服务器提供的工具，例如：
- 询问 "列出我的预算" 来使用 'list_budgets' 工具。
- 询问 "本月预算摘要" 来使用 'budget_summary' 工具。
- 询问 "未批准的交易有哪些" 来使用 'get_unapproved_transactions' 工具。
- 指示 "在 Ally 账户添加一笔今天在 REI 消费 3.98 美元的交易" 来使用 'create_transaction' 工具。（注意: 您可能需要先使用 'list_budgets' 工具获取预算和账户 ID。）

请参考工具的描述和参数说明，以便更有效地使用各项功能。

关键词