Bitpin Mcp Server

What is Bitpin Mcp Server

bitpin-mcp-server is a comprehensive implementation of the Bitpin cryptocurrency exchange API through an MCP (Model Context Protocol) server, designed to facilitate interactions with the Bitpin platform.

Use cases

Use cases include automated trading bots that utilize the API for executing trades, portfolio management tools that track wallet balances and market data, and applications that provide real-time trading insights.

How to use

To use bitpin-mcp-server, you need to set up the server environment, ensure you have .NET 9 or higher installed, and then utilize the provided tools to interact with the Bitpin API for various trading operations.

Key features

Key features include retrieving wallet balances, market data, order details, and executing different types of orders such as limit orders, market orders, stop-limit orders, and OCO (One Cancels the Other) orders.

Where to use

bitpin-mcp-server can be used in the cryptocurrency trading sector, particularly for developers and traders looking to automate their trading strategies and manage their cryptocurrency portfolios effectively.

This repository provides an MCP server implementation for the Bitpin cryptocurrency exchange. The server exposes several tools for interacting with the Bitpin API, such as retrieving wallet balances, market data, order details, and executing various types of orders like limit orders, market orders, stop-limit orders, and OCO (One Cancels the Other) orders.

📺 Demo

Check out a live demo of the Bitpin MCP Server in action, showcasing LLM-powered crypto trading:

Features

The MCP server provides the following tools:

• GetWalletsListAsync: Retrieve a list of wallet balances for various cryptocurrencies.
• GetMarketsListAsync: Retrieve a list of all supported trading markets.
• GetTickersListAsync: Retrieve the current price list of Bitpin’s markets.
• GetCurrenciesAsync: Retrieve a list of supported cryptocurrencies with details such as symbol, name, and tradability status.
• GetOrderbooksAsync: Retrieve the open orders in a specific trading market.
• GetMatchesAsync: Retrieve the latest executed trades for a specific market.
• CreateLimitOrderAsync: Place a limit order to buy or sell a cryptocurrency at a specified price.
• CreateMarketOrderAsync: Place a market order to instantly buy or sell at the best available price.
• CreateStopLimitOrderAsync: Place a stop-limit order to buy or sell once a specific stop price is reached.
• CreateOcoOrderAsync: Place an OCO (One Cancels the Other) order to manage both limit and stop-limit orders simultaneously.
• GetOrdersAsync: Retrieve your list of orders.
• GetCompeletedOrdersAsync: Retrieve details of your completed orders (executed trades).
• GetOrderByIdAsync: Retrieve a specific order by its order ID.
• CancelOrderByIdAsync: Cancel a specific order by its order ID.

Prerequisites

• .NET 9 or higher
• The BitpinClient NuGet package
• Access to the Bitpin API (API Key and Secret)

Setting Up the Server

1. Install Dependencies
   Ensure that your project references the required BitpinClient package and all necessary dependencies for MCP server tools.

2. Configure Bitpin API Settings
   Set up your API Key and Secret for the Bitpin API in the BitpinClientSettings:

   var settings = new BitpinClientSettings()
   {
       Key = "****",  // Replace with your Bitpin API Key
       Secret = "****",  // Replace with your Bitpin API Secret
   };
   

3. MCP Server Configuration
   Add the MCP server configuration to your application settings:

   {
     "mcpServers": {
       "BitpinExchange": {
         "command": "dotnet",
         "args": [
           "run",
           "--project",
           "D:\\projects\\bitpin-mcp-server\\src\\MCPServer\\MCPServer.csproj",
           "--no-build"
         ],
         "env": {
           "BITPIN_API_KEY": "****",
           "BITPIN_API_SECRET": "****",
           "BITPIN_API_URL": "https://api.bitpin.org/api/v1/"
         }
       }
     }
   }
   

4. Configure Services in Program.cs

   Use the following configuration to add the BitpinClient service and set up the MCP server:

   using BitpinClient;
   using Microsoft.Extensions.DependencyInjection;
   using Microsoft.Extensions.Hosting;
   
   var builder = Host.CreateEmptyApplicationBuilder(settings: null);
   
   var settings = new BitpinClientSettings()
   {
       Key = "****", // Replace with your API Key
       Secret = "****", // Replace with your API Secret
   };
   
   builder.Services.AddBitpinClient(settings);
   
   builder.Services.AddMcpServer()
       .WithStdioServerTransport()
       .WithToolsFromAssembly();
   
   var app = builder.Build();
   
   await app.RunAsync();
   

Testing

The project includes comprehensive unit tests to ensure the reliability of the Bitpin client integration. The tests are organized into several categories:

• MarketData: Tests for retrieving market information, tickers, orderbooks, and currency data
• Authentication: Tests for token retrieval and refresh functionality
• UserData: Tests for retrieving user wallet information
• OrderManagement: Tests for retrieving, canceling, and managing orders
• OrderCreation: Tests for creating different types of orders (limit, market, stop-limit, OCO)
• ErrorHandling: Tests for proper handling of error conditions

Running the Tests

To run the tests, use the following command:

dotnet test

To run tests from a specific category:

dotnet test --filter "Category=MarketData"

Test Configuration

The tests use a BitpinClientSettings configuration with API keys. For security reasons, these keys are masked in the test code. When running tests locally, replace the placeholder values with your actual API keys.

Note: Some tests that create real orders on the exchange are marked with [Ignore] to prevent accidental execution. These tests should only be run manually and with caution.

Conclusion

This MCP server provides an easy way to integrate with the Bitpin API and interact with your wallets, orders, and markets. You can place orders, retrieve market data, and manage your assets efficiently using these tools.