Clover MCP

🚀 Clover MCP (Model Context Protocol) Server

A minimal MCP server that uses OAuth authentication to interact with the Clover API.

🚀 Quick Start

Using Claude AI (Recommended)

1. Add the following to your Claude MCP settings (usually at ~/.config/anthropic/claude.mcp.json):

{
  "mcpServers": {
    "clover": {
      "command": "npx",
      "args": ["-y", "@ibraheem4/clover-mcp"],
      "env": {
        "CLOVER_CLIENT_ID": "your-clover-client-id",
        "CLOVER_CLIENT_SECRET": "your-clover-client-secret",
        "CLOVER_BASE_URL": "https://apisandbox.dev.clover.com"
      },
      "disabled": false,
      "autoApprove": ["initiate_oauth_flow", "get_merchant_info", "list_inventory", "list_orders"]
    }
  }
}

2. When using Claude:

/mcp use clover

3. Initiate the OAuth flow in your conversation with Claude:

Can you help me connect to my Clover account?

Command Line Usage

You can run the MCP server directly:

# Install and run once
npx @ibraheem4/clover-mcp

# With credentials
CLOVER_CLIENT_ID=your-client-id CLOVER_CLIENT_SECRET=your-client-secret npx @ibraheem4/clover-mcp

✨ Features

This MCP server allows generative AI models and other clients to access your Clover merchant data via the Model Context Protocol. Through this integration, models can:

• Get merchant information
• List inventory items
• List orders
• Access individual items and orders

📦 Installation

Before using this MCP server, you need to set up your Clover app:

1. Create a Clover developer account at developer.clover.com
2. Register a new app in the Clover developer dashboard
3. Configure your app:
   • Site URL: http://localhost:4000/oauth-callback
   • Default OAuth response: Code
4. Note down your client ID and client secret
5. Add these credentials to your environment variables or .env file

💻 Usage Examples

Examples for Using with Claude

Here are some example prompts you can use with Claude:

1. Connect to Clover

   I want to connect to my Clover account.
   

2. Get Merchant Information

   Do you have information about my Clover merchant account?
   

3. List Inventory Items

   Show me the top 10 items in my inventory.
   

4. List Orders

   Can you list my recent orders?
   

📚 Documentation

Local Installation

1. Clone this repository
2. Install dependencies:

   npm install
   

3. Set up OAuth credentials:

   cp .env.example .env
   # Edit the .env file with your Clover OAuth credentials
   

4. Build the TypeScript code:

   npm run build
   

5. Start the server:

   npm start
   

Troubleshooting

• Ensure you have correctly set the environment variables CLOVER_CLIENT_ID and CLOVER_CLIENT_SECRET
• Verify that API requests are successful by checking the console output

📄 License

This project is licensed under the MIT License.