Clover MCP Server

by ibraheem4
Verified

hybrid server

The server is able to function both locally and remotely, depending on the configuration or use case.

Integrations

  • Supports loading Clover OAuth credentials from .env files for secure configuration of the MCP server.

  • Allows installation and running of the Clover MCP server via npx commands, making it easy to deploy and integrate with the Clover API.

  • Used for development of the MCP server, with build processes that compile TypeScript code before deployment.

Servidor Clover MCP (Protocolo de contexto de modelo)

Un servidor MCP mínimo para interactuar con la API de Clover mediante la autenticación OAuth.

Descripción general

Este servidor MCP permite que los modelos de IA generativa y otros clientes accedan a los datos de sus comerciantes de Clover mediante el Protocolo de Contexto de Modelo. Con esta integración, los modelos pueden:

  • Recuperar información del comerciante
  • Lista de artículos del inventario
  • Órdenes de lista
  • Acceder a artículos y pedidos individuales

Inicio rápido

Uso con Claude AI (recomendado)

  1. Agregue esto a su configuración de Claude MCP (generalmente en ~/.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"] } } }
  1. Úselo con Claude:
/mcp use clover
  1. Inicie el flujo OAuth en su conversación con Claude:
Can you help me connect to my Clover account?

Uso a través de la línea de comandos

Puede ejecutar el servidor MCP directamente:

# Install and run in one command npx @ibraheem4/clover-mcp # With credentials CLOVER_CLIENT_ID=your-client-id CLOVER_CLIENT_SECRET=your-client-secret npx @ibraheem4/clover-mcp

Configuración de OAuth de Clover

Antes de utilizar este servidor MCP, debe configurar una aplicación Clover:

  1. Cree una cuenta de desarrollador de Clover en developer.clover.com
  2. Registrar una nueva aplicación en el Panel de desarrolladores de Clover
  3. Configura tu aplicación con:
    • URL del sitio: http://localhost:4000/oauth-callback
    • Respuesta OAuth predeterminada: Code
  4. Anote su ID de cliente y su secreto de cliente
  5. Agregue estas credenciales a su entorno o archivo .env

Herramientas MCP

Las siguientes herramientas están disponibles a través del protocolo MCP:

  • get_oauth_status : Comprueba si las credenciales de OAuth están disponibles
  • initiate_oauth_flow : Inicia el flujo OAuth para obtener tokens de acceso
  • get_merchant_info : Obtener información sobre el comerciante
  • list_inventory : Lista de artículos de inventario con filtros opcionales
  • list_orders : Lista de pedidos con filtros opcionales

Ejemplo de uso con Claude

A continuación se muestran algunos ejemplos de indicaciones que puedes utilizar con Claude después de conectarte:

  1. Conectarse a Clover :
    I'd like to connect to my Clover account.
  2. Obtener información del comerciante :
    What information do you have about my Clover merchant account?
  3. Lista de artículos del inventario :
    Show me the first 10 items in my inventory.
  4. Órdenes de lista :
    Can you list my most recent orders?

Desarrollo

Instalación local

  1. Clonar este repositorio
  2. Instalar dependencias:
    npm install
  3. Configure sus credenciales de OAuth:
    cp .env.example .env # Edit .env with your Clover OAuth credentials
  4. Construya el código TypeScript:
    npm run build
  5. Inicie el servidor MCP:
    ./run.sh

Actualizaciones de publicación

Para publicar una nueva versión en npm:

# Update version in package.json npm version patch # or minor, or major # Build and publish npm run build npm publish

Solución de problemas

Si encuentra problemas con OAuth:

  1. Verifique que su aplicación Clover esté registrada correctamente
  2. Comprueba que la URL del sitio en la configuración de tu aplicación esté configurada en http://localhost:4000/oauth-callback
  3. Asegúrese de que su ID de cliente y su secreto de cliente sean correctos
  4. Asegúrese de que la "Respuesta OAuth predeterminada" esté configurada en "Código" en el panel del desarrollador.
  5. Intente iniciar el flujo OAuth nuevamente con initiate_oauth_flow

Licencia

Instituto Tecnológico de Massachusetts (MIT)

-
security - not tested
A
license - permissive license
-
quality - not tested

Permite que los agentes de IA accedan e interactúen con los datos de comerciantes, el inventario y los pedidos de Clover a través de un servidor MCP autenticado mediante OAuth seguro.

  1. Overview
    1. Quick Start
      1. Using with Claude AI (Recommended)
      2. Using via Command Line
    2. Clover OAuth Setup
      1. MCP Tools
        1. Example Usage with Claude
          1. Development
            1. Local Installation
            2. Publishing Updates
          2. Troubleshooting
            1. License
              ID: pfh59dosg1