个人财务管理协议服务器

Quantix个人财务API的MCP服务器,提供完整的财务账户、交易、信用卡管理功能,适用于个人财务管理场景。

  • by marcosnunesmbs
  • TypeScript
  • 本地部署
  • 更新于
在 GitHub 查看 marcosnunesmbs/quantix-mcp

使用说明

Quantix个人理财MCP服务器

用于Quantix个人金融API的MCP(模型上下文协议)服务器。将所有端点作为MCP工具公开,具有完整的输入验证和模块化架构。

特性

  • 账户:管理银行账户、钱包、储蓄和投资。
  • 分类:创建、列出、更新和删除财务类别(收入/支出)。
  • 信用卡:管理卡片、查看/支付对账单和跟踪对账单状态。
  • 交易:带过滤器(月、日期范围、帐户、类别、卡、类型、付款状态)、定期付款和分期付款处理的完整CRUD。
  • 交易(已付款状态):将交易标记为已付款或未付款。
  • 设置:管理全局用户首选项(姓名、货币、语言)。
  • 摘要:按月份或自定义日期范围列出的财务摘要——收入、支出、余额、信用卡总额和类别细分。
  • 数据:导出和导入所有用户数据的完整备份。

所有工具输入均通过以下方式进行验证 佐德 符合OpenAPI规范的模式。

先决条件

  • Node.js(v18或更高版本)
  • npm
  • 访问Quantix API和API密钥

安装

  1. 克隆或导航到项目存储库。

  2. 安装依赖项:

    npm install
    

配置

创建一个 .env 项目根目录中的文件:

QUANTIX_API_URL=https://api.quantix.example.com
QUANTIX_API_KEY=your_api_key_here
MCPPORT=3001

建设项目

npm run build

编译后的输出将在 dist 目录。

用法

快速入门(npx)

npx quantix-mcp

确保环境变量(QUANTIX_API_URL, QUANTIX_API_KEY)设置在您的环境中。

发展

npm run dev

生产

npm start

MCP检查员(建议用于测试)

  1. 构建项目:
    npm run build
    
  2. 运行检查器:
    npx @modelcontextprotocol/inspector node dist/index.js
    
  3. 打开提供的URL与您的服务器进行交互。

暴露的MCP工具

类别 工具名称 描述
账户 create_account 创建新的财务账户
get_accounts 列出所有有当前余额的账户
get_account 获取特定帐户的详细信息
update_account 更新帐户名称或类型
delete_account 删除帐户
get_account_balance 获取账户的当前余额
get_account_transactions 列出与账户关联的所有交易
分类 create_category 创建新的财务类别(收入/支出)
get_categories 列出所有类别
get_category 按ID获取类别
update_category 更新类别名称或颜色
delete_category 删除类别
信用卡 create_credit_card 创建新信用卡
get_credit_cards 列出所有信用卡
get_credit_card 凭身份证办理信用卡
update_credit_card 更新信用卡详细信息
delete_credit_card 删除信用卡
get_statement 获取特定月份的对账单(YYYY-MM)
get_statement_status 获取对账单的付款状态
pay_statement 将所有对账单交易标记为已支付
交易 create_transaction 记录新的收入或支出
get_transactions 列出交易记录--筛选器: month, startDate, endDate, accountId, categoryId, creditCardId, type, paid
get_transaction 按ID获取交易详情
update_transaction 更新交易(支持 mode:单次/待定/全部用于定期/分期付款)
pay_transaction 将交易标记为已付款/已收款
unpay_transaction 将交易标记为未付款
delete_transaction 删除交易(支持 mode:单一/待定/全部)
设置 create_settings 创建全局用户设置(仅在尚未创建时)
get_settings 获取全局设置
update_settings 更新全局设置
摘要 get_summary 财务摘要----提供 month (YYYY-MM) 或 startDate + endDate (年-月-日)
数据 export_data 将所有用户数据导出为完整备份
import_data 导入备份(mode: reset 首先清除所有数据, increment 跳过现有ID)

看 openapi.yaml 在项目根目录下查看完整的端点和模式详细信息。

使用Claude Desktop进行设置

  1. 找到您的Claude Desktop配置文件:

    • macOS: ~/Library/Application Support/Claude/claude_desktop_config.json
    • 窗户: %APPDATA%\Claude\claude_desktop_config.json
  2. 添加服务器配置:

    使用npx(推荐):

    {
      "mcpServers": {
        "quantix": {
          "command": "npx",
          "args": ["-y", "quantix-mcp"],
          "env": {
            "QUANTIX_API_URL": "https://api.quantix.example.com",
            "QUANTIX_API_KEY": "your_api_key_here"
          }
        }
      }
    }
    

    使用本地构建(适用于开发人员):

    {
      "mcpServers": {
        "quantix": {
          "command": "node",
          "args": ["/absolute/path/to/dist/index.js"],
          "env": {
            "QUANTIX_API_URL": "https://api.quantix.example.com",
            "QUANTIX_API_KEY": "your_api_key_here"
          }
        }
      }
    }
    

测试

npm test

许可证

国际学生委员会