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.

Clover MCP(モデルコンテキストプロトコル)サーバー

OAuth 認証を使用して Clover API と対話するための最小限の MCP サーバー。

概要

このMCPサーバーにより、生成AIモデルやその他のクライアントは、モデルコンテキストプロトコルを使用してClover加盟店データにアクセスできます。この統合により、モデルは以下のことが可能になります。

  • 販売者情報を取得する
  • 在庫品目を一覧表示する
  • リスト注文
  • 個々の商品や注文にアクセスする

クイックスタート

Claude AIと併用(推奨)

  1. これを Claude MCP 設定 (通常は~/.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. クロードと一緒に使用してください:
/mcp use clover
  1. Claude との会話で OAuth フローを開始します。
Can you help me connect to my Clover account?

コマンドラインからの使用

MCP サーバーを直接実行できます。

# 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

Clover OAuth セットアップ

この MCP サーバーを使用する前に、Clover アプリを設定する必要があります。

  1. developer.clover.comで Clover 開発者アカウントを作成します。
  2. Clover開発者ダッシュボードに新しいアプリを登録する
  3. アプリを次のように構成します。
    • サイト URL: http://localhost:4000/oauth-callback
    • デフォルトのOAuthレスポンス: Code
  4. クライアントIDとクライアントシークレットをメモしてください
  5. これらの資格情報を環境または.envファイルに追加します

MCPツール

MCP プロトコル経由で利用できるツールは次のとおりです。

  • get_oauth_status : OAuth 認証情報が利用可能かどうかを確認する
  • initiate_oauth_flow : アクセストークンを取得するための OAuth フローを開始する
  • get_merchant_info : 販売者に関する情報を取得する
  • list_inventory : オプションのフィルターを使用して在庫アイテムを一覧表示する
  • list_orders : オプションのフィルターを使用して注文を一覧表示する

クロードとの使用例

以下は、接続後に Claude で使用できるプロンプトの例です。

  1. クローバーに接続:
    I'd like to connect to my Clover account.
  2. 販売者情報を取得する:
    What information do you have about my Clover merchant account?
  3. 在庫品目一覧:
    Show me the first 10 items in my inventory.
  4. リスト注文:
    Can you list my most recent orders?

発達

ローカルインストール

  1. このリポジトリをクローンする
  2. 依存関係をインストールします:
    npm install
  3. OAuth 資格情報を設定します。
    cp .env.example .env # Edit .env with your Clover OAuth credentials
  4. TypeScript コードをビルドします。
    npm run build
  5. MCP サーバーを起動します。
    ./run.sh

出版の更新

新しいバージョンを npm に公開するには:

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

トラブルシューティング

OAuth の問題が発生した場合:

  1. Cloverアプリが正しく登録されていることを確認してください
  2. アプリ設定のサイトURLがhttp://localhost:4000/oauth-callbackに設定されていることを確認してください。
  3. クライアントIDとクライアントシークレットが正しいことを確認してください
  4. 開発者ダッシュボードで「デフォルトのOAuthレスポンス」が「コード」に設定されていることを確認してください。
  5. OAuthフローを再度initiate_oauth_flowで開始してみます

ライセンス

マサチューセッツ工科大学

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

AI エージェントが、安全な OAuth 認証 MCP サーバーを介して Clover の販売者データ、在庫、注文にアクセスし、対話できるようにします。

  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