Clover MCP

🚀 Clover MCP（モデルコンテキストプロトコル）サーバー

OAuth認証を使用してClover APIとやり取りする最小限の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"]
    }
  }
}

2. Claudeを使用する際に、以下のコマンドを実行します。

/mcp use clover

3. Claudeとの会話でOAuthフローを開始します。

你能帮我连接到我的Clover账户吗？

コマンドラインでの使用

MCPサーバーを直接実行することもできます。

# 一度だけインストールして実行
npx @ibraheem4/clover-mcp

# 認証情報を指定して実行
CLOVER_CLIENT_ID=your-client-id CLOVER_CLIENT_SECRET=your-client-secret npx @ibraheem4/clover-mcp

✨ 主な機能

このMCPサーバーを使用することで、生成AIモデルやクライアントは以下のことができます。

• マーチャント情報の取得
• 在庫商品の一覧表示
• 注文の一覧表示
• 個々の商品や注文へのアクセス

📦 インストール

Clover OAuthの設定

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

1. developer.clover.comでClover開発者アカウントを作成します。
2. Clover開発者ダッシュボードで新しいアプリを登録します。
3. アプリを以下のように設定します。
   • サイトURL：http://localhost:4000/oauth-callback
   • デフォルトのOAuth応答：Code
4. クライアントIDとクライアントシークレットをメモします。
5. これらの認証情報を環境変数または.envファイルに追加します。

ローカル環境でのインストール

1. このリポジトリをクローンします。
2. 依存関係をインストールします。

npm install

3. OAuth認証情報を設定します。

cp .env.example .env
# .envファイルを編集してCloverのOAuth認証情報を入力します。

4. TypeScriptコードをビルドします。

npm run build

5. サーバーを起動します。

npm start

💻 使用例

基本的な使用法

Claudeで使用する場合の例をいくつか紹介します。

1. Cloverに接続する

我想连接到我的Clover账户。

2. マーチャント情報を取得する

您有关于我的Clover商家账户的信息吗？

3. 在庫商品を一覧表示する

显示我库存中的前10个项目。

4. 注文を一覧表示する

您能列出我最近的订单吗？

🔧 技術詳細

以下のツールはMCPプロトコルを通じて使用できます。

• get_oauth_status：OAuth認証情報が利用可能かどうかを確認します。
• initiate_oauth_flow：アクセストークンを取得するためのOAuthフローを開始します。
• get_merchant_info：マーチャント情報を取得します。
• list_inventory：在庫商品を一覧表示し、オプションでフィルターを適用できます。
• list_orders：注文を一覧表示し、オプションでフィルターを適用できます。

📚 ドキュメント

トラブルシューティング

• 環境変数CLOVER_CLIENT_IDとCLOVER_CLIENT_SECRETが正しく設定されていることを確認してください。
• APIリクエストが成功しているかどうかをコンソール出力で確認してください。

📄 ライセンス

このプロジェクトはMIT Licenseの下で提供されています。