Ntropy

🚀 Ntropy MCP Server

The Ntropy API MCP Server is designed to enrich banking data. It enables LLM agents working with financial data to easily call any Ntropy API endpoint.

🚀 Quick Start

📦 Installation

Install using npm:

npm install @modelcontextprotocol/mcp-server

💻 Usage Examples

1. Create an MCP Server instance and set the API key:

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

2. Use the tools for operations:
   • Create an account holder:

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

   • Update account holder information:

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

   • Enrich transaction data:

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

✨ Features

Tools

The server implements the following tools to interact with the Ntropy API:

• check_connection: Verify the connection to the Ntropy API.
  • Return: Connection status information.
• set_api_key: Set or update the Ntropy API key at runtime.
  • Parameter: api_key (string).
  • Return: Status of API key update and verification.
• create_account_holder: Create an account holder.
  • Parameters: id (string/integer), type (string), name (string).
  • Return: Details of the created account holder.
• update_account_holder: Update an existing account holder.
  • Parameters: id (string/integer), name (string, optional), type (string, optional).
  • Return: Details of the updated account holder.
• enrich_transaction: Enrich a bank transaction.
  • Parameters: id (string/integer), description (string), date (string), amount (float), entry_type (string), currency (string), account_holder_id (string/integer), country (string, optional).
  • Return: Enriched transaction data.
• get_account_holder: Get the details of an account holder.
  • Parameter: account_holder_id (string/integer).
  • Return: Details of the account holder.
• list_transactions: List all transactions of an account holder.
  • Parameters: account_holder_id (string/integer), limit (integer, optional, default is 10), offset (integer, optional, default is 0).
  • Return: List of transactions.
• bulk_enrich_transactions: Bulk enrich multiple transactions.
  • Parameter: transactions (an array containing transaction objects, each transaction object includes the following fields:
    • id: Transaction ID (string/integer).
    • description: Transaction description (string).
    • date: Transaction date (string).
    • amount: Transaction amount (float).
    • entry_type: Entry type (string).
    • currency: Currency code (string).
    • account_holder_id: Account holder ID (string/integer).
  • Return: An array of enriched transaction objects.

🔧 Debugging

You can use the MCP Inspector to debug the server. For npm installation:

npx @modelcontextprotocol/inspector MCPServer -p 3000

🏗️ Building

Docker build:

docker build -t ntropy-mcp .

🤝 Contributing

Pull requests are welcome! Contributions in the form of new ideas, bug fixes, or feature enhancements are highly appreciated.

📄 License

The ntropy-mcp project is licensed under the MIT License. This means you are free to use, modify, and distribute the software, provided you comply with the terms and conditions of the MIT License. For more details, please refer to the LICENSE file in the project repository.