Ntropy

🚀 Ntropy MCP サーバー

銀行データを充実させるためのNtropy API MCPサーバーです。これにより、財務データを扱うLLMエージェントが簡単に任意のNtropy APIエンドポイントを呼び出すことができます。

🚀 クイックスタート

📦 インストール

npmを使用してインストールします：

npm install @modelcontextprotocol/mcp-server

💻 使用例

基本的な使用法

1. MCPサーバーインスタンスを作成し、APIキーを設定します：

const { MCPServer } = require('@modelcontextprotocol/mcp-server');
const server = new MCPServer({
  apiKey: 'your_api_key_here',
});
server.listen(3000);

高度な使用法

2. ツールを使用して操作を行います：
   • アカウント保有者を作成します：

     await server.createAccountHolder({
       id: "1",
       type: "personal",
       name: "John Doe"
     });
     

   • アカウント保有者の情報を更新します：

     await server.updateAccountHolder({
       id: "1",
       name: "Jane Smith"
     });
     

   • 取引データを充実させます：

     await server.enrichTransaction({
       id: "tx123",
       description: "Grocery Shopping",
       date: "2024-01-01",
       amount: -50.0,
       entry_type: "debit",
       currency: "USD",
       account_holder_id: "1"
     });
     

✨ 主な機能

ツール

このサーバーは、Ntropy APIとやり取りするために以下のツールを実装しています：

• check_connection：Ntropy APIへの接続を検証します

  • 返り値：接続状態情報

• set_api_key：実行時にNtropy APIキーを設定または更新します

  • パラメータ：api_key (文字列)
  • 返り値：APIキーの更新と検証の状態

• create_account_holder：アカウント保有者を作成します

  • パラメータ：id (文字列/整数), type (文字列), name (文字列)
  • 返り値：作成されたアカウント保有者の詳細情報

• update_account_holder：既存のアカウント保有者を更新します

  • パラメータ：id (文字列/整数), name (文字列、オプション), type (文字列、オプション)
  • 返り値：更新後のアカウント保有者の詳細情報

• enrich_transaction：銀行取引を充実させます

  • パラメータ：id (文字列/整数), description (文字列), date (文字列), amount (浮動小数点数), entry_type (文字列), currency (文字列), account_holder_id (文字列/整数), country (文字列、オプション)
  • 返り値：充実された取引データ

• get_account_holder：アカウント保有者の詳細情報を取得します

  • パラメータ：account_holder_id (文字列/整数)
  • 返り値：アカウント保有者の詳細情報

• list_transactions：アカウント保有者のすべての取引をリストします

  • パラメータ：account_holder_id (文字列/整数), limit (整数、オプション、デフォルトは10), offset (整数、オプション、デフォルトは0)
  • 返り値：取引リスト

• bulk_enrich_transactions：複数の取引を一括で充実させます

  • パラメータ：transactions (取引オブジェクトを含む配列、各取引オブジェクトは以下のフィールドを含みます：
    • id：取引ID（文字列/整数）
    • description：取引の説明（文字列）
    • date：取引日付（文字列）
    • amount：取引金額（浮動小数点数）
    • entry_type：入金タイプ（文字列）
    • currency：通貨コード（文字列）
    • account_holder_id：アカウント保有者ID（文字列/整数）
  • 返り値：充実された取引オブジェクトの配列

🔧 デバッグ

MCPチェッカーを使用してサーバーをデバッグすることができます。npmでインストールした場合：

npx @modelcontextprotocol/inspector MCPServer -p 3000

🔨 ビルド

Dockerでビルドします：

docker build -t ntropy-mcp .

🤝 コントリビューション

プルリクエストの送信を歓迎します！新しいアイデア、バグ修正、または機能強化の貢献を歓迎します。

📄 ライセンス

ntropy-mcpはMITライセンスの下で提供されています。これは、MITライセンスの条項と条件に従う限り、ソフトウェアを自由に使用、変更、および配布できることを意味します。詳細については、プロジェクトリポジトリ内のLICENSEファイルを参照してください。