项目简介

这是一个 Model Context Protocol (MCP) 服务器实现,旨在连接大型语言模型(LLM)客户端(如 VS Code Copilot Chat、Cursor 等)到您的澳大利亚 Up Bank 银行账户。通过遵循 MCP 标准,它允许 LLM 安全地访问您的银行数据,并利用这些数据进行分析、总结等任务。使用此服务器需要您拥有 Up Bank API 提供的个人访问令牌。

主要功能点

  • 银行账户访问: 获取您的 Up Bank 银行账户列表及详细信息,包括账户余额、类型等。
  • 交易记录查询: 查询您的交易记录,支持按账户、按日期范围、按状态(Held/Settled)、按分类或标签进行过滤。
  • 单笔交易详情: 查看单笔交易的详细信息。
  • 交易分类与标签管理: 支持修改交易的分类和管理交易的标签(添加/移除)。
  • 自定义 Prompt 模板: 提供预定义的 Prompt 模板,例如:
    • 交易总结: 根据指定时间段、账户、分类等条件,总结交易情况,包括总支出、交易笔数等。
    • 账户概览: 提供账户列表和余额信息。
    • 消费预测: 基于近期交易历史预测未来消费(注意:此功能依赖于 LLM 的分析能力和服务器提供的数据)。
  • 安全连接: 通过标准输入输出 (Stdio) 协议与客户端通信,并通过要求 API 密钥确保数据访问安全。

注意:根据 Up Bank API 的限制,此服务器不提供转账或修改账户设置等写操作功能,您的资金安全不受影响。

安装步骤

  1. 安装 Node.js 和 npm (或 yarn): 确保您的系统上已安装 Node.js 环境。
  2. 克隆仓库: 从 GitHub 下载或克隆此项目的代码到您的本地机器。
    git clone https://github.com/sirmews/mcp-upbank.git
    cd mcp-upbank
  3. 安装依赖: 在项目根目录运行以下命令安装所需的依赖库。
    npm install
    # 或者 yarn install
  4. 获取 Up Bank API 令牌: 登录您的 Up Bank 账户,按照其入门指南生成一个个人访问令牌(Personal Access Token)。
  5. 设置环境变量: 将您的 Up Bank API 个人访问令牌设置为名为 'UP_BANK_API_KEY' 的环境变量。这是服务器用于认证和访问您银行数据的凭据。
    • 在 Linux/macOS 上:'export UP_BANK_API_KEY="YOUR_TOKEN_HERE"'
    • 在 Windows 命令提示符下:'set UP_BANK_API_KEY=YOUR_TOKEN_HERE'
    • 在 PowerShell 中:'$env:UP_BANK_API_KEY="YOUR_TOKEN_HERE"'
    • 请将 'YOUR_TOKEN_HERE' 替换为您实际的令牌。建议将此设置添加到您的 shell 配置文件中,以便每次启动终端时自动加载。
  6. 构建项目: 运行构建命令以编译 TypeScript 代码。
    npm run build
    # 或者 yarn build
  7. 启动服务器: 运行编译后的代码启动 MCP 服务器。
    node dist/main.js
    服务器将通过标准输入输出 (stdio) 运行,等待 MCP 客户端连接。

服务器配置 (for MCP Client)

在您的 MCP 客户端(如 VS Code Copilot Chat 设置)中添加新的 MCP 服务器配置时,您需要提供以下信息。这是一个示例 JSON 配置格式,请根据您的实际安装路径进行调整:

{
  "name": "mcp-upbank", // 此MCP服务器在客户端中显示的名称
  "command": [
    "node", // 启动服务器的命令,这里是运行Node.js环境
    "dist/main.js" // 服务器主入口文件的路径,通常是构建后的文件
  ],
  "args": [], // 传递给启动命令的额外参数,此服务器通常不需要
  "env": {
    "UP_BANK_API_KEY": "{{env:UP_BANK_API_KEY}}" // 指示客户端从其运行环境读取UP_BANK_API_KEY环境变量并传递给服务器进程
  },
  "workingDirectory": "/path/to/your/mcp-upbank" // 服务器进程的工作目录,确保可以找到dist/main.js
}

请务必将 '"/path/to/your/mcp-upbank"' 替换为您克隆项目到本地的实际目录路径。

基本使用方法

  1. 确保您已安装并配置好支持 MCP 的 LLM 客户端(例如 VS Code Copilot Chat, Cursor)。
  2. 在客户端的设置中添加一个新的 MCP 服务器连接,并使用上面提供的配置信息,填写正确的 'command' 和 'workingDirectory' 路径。
  3. 确保您在启动客户端或启动此 MCP 服务器进程的环境中已经正确设置了 'UP_BANK_API_KEY' 环境变量。
  4. 连接成功后,您可以在客户端的聊天界面或通过特定的用户界面元素来与此 MCP 服务器交互。LLM 可以通过调用服务器暴露的工具(如 'getAccounts', 'getTransactions')或使用定义的 Prompt 模板(如 'transaction-summary')来访问和分析您的 Up Bank 财务数据。例如,您可以直接在聊天中提问:“我的 Up Bank 账户余额是多少?” 或 “总结我上周的消费情况。”

信息

分类

商业系统