tropipay-mcp-server
v0.1.0
Published
A MCP Server to interact with Tropipay Payments Platform
Maintainers
Readme
TropiPay MCP Server
A Model Context Protocol (MCP) server for interacting with TropiPay's payment platform. This server provides a standardized interface for AI assistants in various development environments to perform TropiPay operations through tools and resources.
✨ Features
- Authentication: Handles OAuth 2.0 client credentials flow with TropiPay
- Modular Architecture: Clean separation of concerns with TypeScript
- TropiPay API Integration: Comprehensive wrapper around TropiPay's functionality
- Tool-Based Interface: Easy integration with AI assistants
- Environment Support: Configure for sandbox or production environments
- Editor Compatibility: Works with VS Code, Cursor, Windsurf, and other MCP-compatible editors
🛠️ Available Tools
Account Management
get_default_account_balance: Retrieve current default account balanceget_profile_data: Get user profile informationget_accounts_list: List all TropiPay accounts
Transactions
get_movement_list: View transaction history with paginationlist_deposit_accounts: List deposit accounts/beneficiaries (bank accounts, crypto wallets, etc.)list_paymentcards: Get list of payment cards (payment links) created by the user
Beneficiary Management
create_internal_beneficiary: Create a new internal TropiPay beneficiary- Required Fields: alias, searchValue (email)
create_external_beneficiary: Create a new external bank account beneficiary- Required Fields: firstName, lastName, accountNumber, currency, countryDestinationId/countryISO
create_crypto_beneficiary: Create a new crypto wallet beneficiary- Required Fields: firstName, lastName, accountNumber (wallet address), currency, network
Payment Links
create_paymentcard: Create payment links (called payment cards in TropiPay)- Required Fields: amount, currency, concept, description
- Optional Fields: reference, favorite, singleUse, expirationDays, reasonId, lang, urlSuccess, urlFailed, urlNotification, serviceDate, accountId
System
test_connection: Verify API connectivity and authentication
📚 Available Resources
The TropiPay MCP Server provides the following reference resources:
tropipay://config: Current TropiPay API configuration and environment settingstropipay://status: TropiPay API connection status and health checktropipay://movement-types: Complete reference of TropiPay movementType IDs and their meaningstropipay://movement-states: Complete reference of TropiPay movement state codes and their meaningstropipay://account-states: Complete reference of TropiPay account state codes and their meanings
🚀 Getting Started
Prerequisites
- Node.js 20+
- npm or yarn
- TropiPay API credentials (Client ID and Client Secret)
Installation
Clone the repository:
git clone https://github.com/yosle/tropipay-mcp-server.git cd tropipay-mcp-server npm installInstall dependencies:
npm install
MCP Client Configuration
You can use this MCP server with any compatible client like LM Studio, Ollama,Copilot, Windsurf, Gemini CLI or Claude Desktop, you'll need to add it to your client's configuration file:
Locate your client's configuration file:
- Claude Desktop:
- Windows:
%APPDATA%/Claude/claude_desktop_config.json - MacOS:
~/Library/Application Support/Claude/claude_desktop_config.json
- Windows:
- Gemini CLI and others: Refer to tehe respective documentation for config file location
- Claude Desktop:
Add the TropiPay MCP Server configuration:
{
"mcpServers": {
// ... other MCP server configurations ...
"Tropipay MCP Server": {
"command": "node",
"args": [
"path/to/tropipay-mcp-server/build/index.js"
],
"env": {
"TROPIPAY_CLIENT_ID": "your_client_id",
"TROPIPAY_CLIENT_SECRET": "your_client_secret",
"TROPIPAY_BASE_URL": "https://sandbox.tropipay.me"
/* Optional https://www.tropipay.com for live environment,
https://sandbox.tropipay.me for sandbox or other for local development,
mock server for testing etc
*/
}
}
}
}Note: Replace
path/to/tropipay-mcp-serverwith the actual path to your TropiPay MCP Server installation. Use escape backslash in Windows"D:\\folder\\tropipay-mcp-server\\or"/folder/tropipay-mcp-server/in Linux/Mac
🏗️ Project Structure
src/
├── client/ # TropiPay client initialization and management
├── config/ # Configuration management
├── resources/ # MCP resource handlers
├── tools/ # Tool definitions and handlers
│ ├── definitions.ts
│ └── handlers.ts
├── types/ # TypeScript type definitions
└── index.ts # Main server entry point🔍 Usage Examples
Get a list of my beneficiaries Getting Account Balance
Get the balance in all my Tropipay accounts 📝 License
This project is licensed under the MIT License - see the LICENSE file for details.
🤝 Contributing
Contributions are welcome! Please feel free to submit a Pull Request.
📧 Contact
For questions or support, please open an issue on GitHub.
