🚀 ynab-mcp-server
ynab-mcp-server 是一个基于 mcp-framework 构建的服务器，它为 YNAB（You Need A Budget）预算工具提供了模型上下文协议 (MCP)。借助此 MCP，你可以与在 https://ynab.com 上设置的 YNAB 预算进行交互。
为了让 AI 能够与该工具交互，你需要获取个人访问令牌，获取地址为：https://api.ynab.com/#personal-access-tokens。当将此 MCP 服务器添加到任何客户端时，你需要提供个人访问令牌作为 YNAB_API_TOKEN。此令牌绝不会直接发送给 LLM（大语言模型），它会安全地存储在环境变量中，仅用于与 YNAB API 通信。
🚀 快速开始
- 克隆仓库：
git clone https://github.com/your-repository.git
- 安装依赖项：
npm install
- 配置环境变量：
export YNAP_API_TOKEN=your_token_here
- 运行服务器：
node dist/index.js
✨ 主要特性
- 提供与 YNAB 预算交互的工具，支持 AI 对话与预算进行交互。
- 具备多种工作流程，如第一次设置、管理超支类别、添加新交易等。
- 提供一系列工具类，可方便地与 YNAB API 进行交互。
📦 安装指南
环境变量设置
指定以下环境变量：
YNAP_API_TOKEN（必需）：个人访问令牌。KNOWLEDGE_DIR（可选）：知识文件存储目录，默认为服务器运行所在的data目录。KNOWLEDGE_FILE（可选）：知识文件名，默认为server-knowledge.json
💻 使用示例
基本的工具类结构
export class YNABTools {
private readonly token: string;
constructor(token: string) {
this.token = token;
}
// 实现具体功能方法
}
📚 详细文档
项目目标
此项目旨在通过 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 # 项目文档
添加组件
要添加新的功能模块：
- 在
src/tools/目录下创建新工具类。 - 实现与 YNAB API 的交互逻辑。
- 更新服务器文件以加载新工具。
发布到 npm
- 登录到 npm：
npm login
- 提交版本更新：
npm version patch
- 发布新版本：
npm publish
其他 MCP 客户端
检查 https://modelcontextprotocol.io/clients 获取更多信息。