README - luno-mcp by luno

Luno MCP Server

A Model Context Protocol (MCP) server that provides access to the Luno cryptocurrency exchange API.

This server enables integration with VS Code's Copilot and other MCP-compatible clients, providing contextual information and functionality related to the Luno cryptocurrency exchange.

⚠️ Beta Warning

This project is currently in beta phase. While we've made every effort to ensure stability and reliability, you may encounter unexpected behavior or limitations. Please use it with care and consider the following:

This MCP server config may change without prior notice
Performance and reliability might not be optimal
Not all Luno API endpoints are implemented yet

We welcome feedback and bug reports to help improve the project. Please report any issues you encounter via the .

Features

Resources: Access to account balances, transaction history, and more
Tools: Functionality for creating and managing orders, checking prices, and viewing transaction details
Security: Secure authentication using Luno API keys
VS Code Integration: Easy integration with VS Code's Copilot features

Usage

Setting up credentials

The server requires your Luno API key and secret. These can be obtained from your Luno account settings, see here for more info: https://www.luno.com/developers.

Command-line options

--transport: Transport type (stdio or sse, default: stdio)
--sse-address: Address for SSE transport (default: localhost:8080)
--domain: Luno API domain (default: api.luno.com)
--log-level: Log level (debug, info, warn, error, default: info)

Available Tools

Tool	Category	Description
`get_ticker`	Market Data	Get current ticker information for a trading pair
`get_order_book`	Market Data	Get the order book for a trading pair
`list_trades`	Market Data	List recent trades for a currency pair
`get_balances`	Account Information	Get balances for all accounts
`create_order`	Trading	Create a new buy or sell order
`cancel_order`	Trading	Cancel an existing order
`list_orders`	Trading	List open orders
`list_transactions`	Transactions	List transactions for an account
`get_transaction`	Transactions	Get details of a specific transaction

Examples

Working with wallets

You can ask Copilot to show your wallet balances:

What are my current wallet balances on Luno?

Trading

You can ask Copilot to help you trade:

Create a limit order to buy 0.001 BTC at 50000 ZAR

Transaction history

You can ask Copilot to show your transaction history:

Show me my recent Bitcoin transactions

Market Data

You can ask Copilot to show market data:

Show me recent trades for XBTZAR

What's the latest price for Bitcoin in ZAR?

VS Code Integration

To integrate with VS Code, add the following to your settings.json file (or click on the badge at the top of this README for the docker config).

With Docker

This configuration will make VS Code run the Docker container. Ensure Docker is running on your system.

{
  "servers": {
    "luno-docker": {
      "command": "docker",
      "args": [
        "run", "--rm", "-i",
        "-e", "LUNO_API_KEY_ID=${input:luno_api_key_id}",
        "-e", "LUNO_API_SECRET=${input:luno_api_secret}",
        // Optional: Add debug info
        // "-e", "LUNO_API_DEBUG=true",
        // Optional: Override default API domain
        // "-e", "LUNO_API_DOMAIN=api.staging.luno.com",
        "ghcr.io/luno/luno-mcp:latest"
      ],
      "inputs": [
         {"id": "luno_api_key_id", "type": "promptString", "description": "Luno API Key ID", "password": true},
         {"id": "luno_api_secret", "type": "promptString", "description": "Luno API Secret", "password": true}
      ]
    }
  }
}

Building from source

For MCP client usage: Add one of the config options below to your VS Code settings.json or mcp.json file. The credentials will be provided through VS Code's input prompts.

For direct development: You'll also need to set up environment variables or a .env file as described in the file.

For stdio transport

"mcp": {
  "servers": {
    "luno": {
      "command": "luno-mcp",
      "args": [],
      "env": {
        "LUNO_API_KEY_ID": "${input:luno_api_key_id}",
        "LUNO_API_SECRET": "${input:luno_api_secret}"
      },
      "inputs": [
        {"id": "luno_api_key_id", "type": "promptString", "description": "Luno API Key ID", "password": true},
        {"id": "luno_api_secret", "type": "promptString", "description": "Luno API Secret", "password": true}
      ]
    }
  }
}

For SSE transport

"mcp": {
  "servers": {
    "luno": {
      "type": "sse",
      "url": "http://localhost:8080/sse"
    }
  }
}

Installation

Prerequisites

Go 1.24 or later
Luno account with API key and secret

Building from Source

Clone the repository:

git clone https://github.com/luno/luno-mcp
cd luno-mcp

Build the binary:
```
go build -o luno-mcp ./cmd/server
```
Make it available system-wide (optional):
```
sudo mv luno-mcp /usr/local/bin/
```

Note: When using with MCP clients like VS Code, credentials are provided through the client's input system. For direct development and testing, see the credential setup instructions in CONTRIBUTING.md.

Security Considerations

This tool requires API credentials that have access to your Luno account. Be cautious when using API keys, especially ones with withdrawal permissions. It's recommended to create API keys with only the permissions needed for your specific use case.

Best Practices for API Credentials

Create Limited-Permission API Keys: Only grant the permissions absolutely necessary for your use case
Never Commit Credentials to Version Control: Ensure .env files are always in your .gitignore
Rotate API Keys Regularly: Periodically regenerate your API keys to limit the impact of potential leaks
Monitor API Usage: Regularly check your Luno account for any unauthorized activity

Contributing

If you'd like to contribute to the development of this project, please see the file for guidelines.