Omise Model Context Protocol (MCP)

このページで扱うトピック

Omise Model Context Protocol (MCP)

AIエージェントがOmise MCPサーバーを使用してOmise APIと連携できるようにします。

Omise Model Context Protocol (MCP) サーバーは、AIエージェントが決済処理、顧客管理、財務業務のためにOmise APIと連携するための一連のツールを提供します。

CursorなどのAI搭載コードエディタやClaude Desktopなどの汎用ツールを使用している場合、当社のMCPサーバーをご利用いただけます。

前提条件

Omise MCPサーバーをインストールする前に、以下の前提条件がインストールされていることを確認してください。

必要なソフトウェア

Node.js 20+: JavaScript実行環境(npmパッケージマネージャーを含む)

注: TypeScriptおよびその他の依存関係は、omise-mcpディレクトリでnpm installを実行すると自動的にインストールされます。

インストール手順

インストール手順については、Node.jsのインストールを参照してください。

Omise APIキー

OmiseアカウントとAPIキーが必要です:

  1. Omiseダッシュボードにアクセス
  2. アカウントを作成またはログイン
  3. 設定 → キーに移動
  4. APIキーを取得:
    • テスト環境: pkey_test_およびskey_test_で始まるキーを使用
    • 本番環境: pkey_live_およびskey_live_で始まるキーを使用

重要: 開発中は常にテストキーを使用し、本番環境でのみライブキーを使用してください。

ローカルサーバー

お好みの開発環境のセットアップ手順に従って、ローカルOmise MCPサーバーを実行します。

Claude

Claude DesktopでOmise MCPをセットアップするには:

  1. GitHubからomise-mcpをダウンロード
  2. コマンドプロンプトでomise-mcpディレクトリに移動し、npm installを実行してすべての依存関係をインストールします。
  3. Claude Desktopをダウンロードしてインストール
  4. Claude Desktopを開き、設定に移動します。開発者をクリックし、次に設定を編集をクリックします。
    Edit Config
  5. claude_desktop_config.jsonファイルを編集します。内容は以下のようになります:

    {
      "mcpServers": {
        "omise-mcp-server": {
          "command": "/opt/homebrew/bin/npx",
          "args": [
            "tsx",
            "/path/to/your/omise-mcp/src/index.ts"
          ],
          "cwd": "/path/to/your/omise-mcp/",
          "env": {
            "NODE_ENV": "prod",
            "OMISE_ENVIRONMENT": "test",
            "OMISE_API_VERSION": "2019-05-29",
            "OMISE_PUBLIC_KEY": "<<YOUR_PUBLIC_KEY>>",
            "OMISE_SECRET_KEY": "<<YOUR_SECRET_KEY>>",
            "OMISE_BASE_URL": "https://api.omise.co",
            "OMISE_VAULT_URL": "https://vault.omise.co",
            "OMISE_TIMEOUT": "30000",
            "OMISE_RETRY_ATTEMPTS": "3",
            "OMISE_RETRY_DELAY": "1000",
            "SERVER_NAME": "omise-mcp-server-prod",
            "SERVER_VERSION": "1.0.0",
            "TOOLS": "all",
            "LOG_LEVEL": "info",
            "LOG_FORMAT": "json",
            "LOG_REQUESTS": "true",
            "LOG_RESPONSES": "false",
            "RATE_LIMIT_ENABLED": "true",
            "RATE_LIMIT_MAX_REQUESTS": "500",
            "RATE_LIMIT_WINDOW_MS": "60000"
          }
        }
      }
    }
    
    注: /path/to/your/omise-mcp/src/index.tsを、ダウンロードしたomise-mcpフォルダ内のindex.tsファイルへの実際のパスに置き換え、/path/to/your/omise-mcp/omise-mcpフォルダへの正確なパスに置き換えてください。

    APIキー: <<YOUR_PUBLIC_KEY>>および<<YOUR_SECRET_KEY>>を実際のOmise APIキーに置き換えてください。これらはOmiseダッシュボード → 設定 → キーから取得できます。ライブアカウントの場合はライブキーを、テストアカウントの場合はテストキーを使用してください。

  6. ファイルを保存して閉じます。
  7. Claude Desktopを再起動します。
  8. 設定 → 開発者に移動すると、Omise MCPサーバーが実行中でClaudeに接続されていることが確認できます。
    MCP Server is Running
  9. Claudeチャットインターフェースから、検索とツールアイコンをクリックします。omise-mcp-serverが有効になっているはずです。
    MCP Server is Enabled in Claude

Cursor

CursorでOmise MCPをセットアップするには:

  1. Cursor AIをダウンロード
  2. Cursor APIにログイン
  3. Cursor → 設定 → Cursor設定 → ツールとMCPに移動
  4. MCPサーバーを追加をクリック
  5. 以下のように設定を入力します:

    {
      "mcpServers": {
        "omise-mcp-server": {
          "command": "/path/to/npx",
          "args": [
            "tsx",
            "/path/to/your/omise-mcp/src/index.ts"
          ],
          "cwd": "/path/to/your/omise-mcp",
          "env": {
            "NODE_ENV": "prod",
            "OMISE_ENVIRONMENT": "test",
            "OMISE_API_VERSION": "2019-05-29",
            "OMISE_PUBLIC_KEY": "<<YOUR_PUBLIC_KEY>>",
            "OMISE_SECRET_KEY": "<<YOUR_SECRET_KEY>>",
            "OMISE_BASE_URL": "https://api.omise.co",
            "OMISE_VAULT_URL": "https://vault.omise.co",
            "OMISE_TIMEOUT": "30000",
            "OMISE_RETRY_ATTEMPTS": "3",
            "OMISE_RETRY_DELAY": "1000",
            "SERVER_NAME": "omise-mcp-server-prod",
            "SERVER_VERSION": "1.0.0",
            "TOOLS": "all",
            "LOG_LEVEL": "info",
            "LOG_FORMAT": "json",
            "LOG_REQUESTS": "true",
            "LOG_RESPONSES": "false",
            "RATE_LIMIT_ENABLED": "true",
            "RATE_LIMIT_MAX_REQUESTS": "500",
            "RATE_LIMIT_WINDOW_MS": "60000"
          }
        }
      }
    }
    
    注:
    • /path/to/npxをnpx実行可能ファイルへの実際のパス(例: /Users/username/.asdf/shims/npxまたは/opt/homebrew/bin/npx)に置き換えてください
    • /path/to/your/omise-mcp/src/index.tsindex.tsファイルへの実際のパスに置き換えてください
    • /path/to/your/omise-mcpomise-mcpフォルダへの実際のパスに置き換えてください
    • <<YOUR_PUBLIC_KEY>>および<<YOUR_SECRET_KEY>>Omiseダッシュボード → 設定 → キーから取得した実際のOmise APIキーに置き換えてください

  6. 設定を保存します
  7. Cursorを再起動します
  8. 設定 → Cursor設定 → ツールとMCPに移動します。Omise MCPサーバーが有効になっているはずです。
    MCP Server is Enabled in Cursor

CLI

次のコマンドでMCPサーバーをローカルで起動します:

cd /path/to/your/omise-mcp
npx tsx src/index.ts

サーバーを実行する前に、OMISE_SECRET_KEYおよびOMISE_PUBLIC_KEY環境変数が設定されていることを確認してください。

設定パラメータ

設定パラメータを理解することで、特定のニーズに合わせてMCPサーバーをカスタマイズできます:

コア設定

変数 説明 必須 デフォルト
OMISE_PUBLIC_KEY Omiseパブリック APIキー - pkey_test_bgwtwgdmon2i23pwaxw
OMISE_SECRET_KEY Omiseシークレット APIキー - skey_test_ueq529yrmuzk0gmu730
OMISE_ENVIRONMENT 環境モード - testまたはproduction
OMISE_API_VERSION Omise APIバージョン 2019-05-29 2019-05-29

URL設定

変数 説明 必須 デフォルト
OMISE_BASE_URL Omise APIベースURL - `https://api.omise.co https://api.omise.co`
OMISE_VAULT_URL トークン化のためのOmise Vault URL - `https://vault.omise.co https://vault.omise.co`

ネットワーク設定

変数 説明 必須 デフォルト
OMISE_TIMEOUT APIリクエストタイムアウト(ミリ秒) - 30000 30000
OMISE_RETRY_ATTEMPTS 失敗したリクエストの再試行回数 - 3 3
OMISE_RETRY_DELAY 再試行間の遅延(ミリ秒) - 1000 1000

サーバー設定

変数 説明 必須 デフォルト
SERVER_NAME サーバー識別子 - omise-mcp-server omise-mcp-server-prod
SERVER_VERSION サーバーバージョン - 1.0.0 1.0.0
NODE_ENV Node.js環境 - development staging、production

アクセス制御設定

変数 説明 必須 デフォルト
TOOLS 許可されたMCPツールのカンマ区切りリスト、またはすべてのツールを有効にする場合は all - all または create_charge,list_charges,retrieve_charge など

アクセス制御機能:

  • ツールホワイトリスト: TOOLS環境変数で指定されたツールのみがMCPクライアントに公開されます
  • 厳密な検証: ツール名は起動時に50以上の利用可能なツールの完全なリストに対して検証されます
  • ランタイム適用: 許可されていないツール呼び出しは構造化されたエラーメッセージで拒否されます
  • 起動時検証: 無効なツール名が提供された場合、サーバーは起動に失敗します

例:

# すべてのツールを有効化
TOOLS=all

# 特定のツールのみを有効化
TOOLS=create_charge,retrieve_charge,list_charges

# 無効なツール名は起動失敗を引き起こす
TOOLS=invalid_tool # ❌ "Invalid tool names" エラーで失敗

環境別設定サンプル

開発環境:

{
  "NODE_ENV": "development",
  "OMISE_ENVIRONMENT": "test",
  "OMISE_PUBLIC_KEY": "pkey_test_...",
  "OMISE_SECRET_KEY": "skey_test_...",
  "TOOLS": "all",
  "LOG_LEVEL": "debug",
  "LOG_REQUESTS": "true",
  "LOG_RESPONSES": "true"
}

本番環境:

{
  "NODE_ENV": "production",
  "OMISE_ENVIRONMENT": "production",
  "OMISE_PUBLIC_KEY": "pkey_live_...",
  "OMISE_SECRET_KEY": "skey_live_...",
  "TOOLS": "create_charge,retrieve_charge,list_charges,create_customer,retrieve_customer",
  "LOG_LEVEL": "warn",
  "LOG_RESPONSES": "false",
  "RATE_LIMIT_MAX_REQUESTS": "1000"
}

ツール

サーバーは以下のMCPツールを公開します。プロンプトインジェクション攻撃を回避するため、Omise MCPを他のサーバーと使用する際は注意してください。特にチャージの作成や決済処理などの機密性の高い操作については、実行前に必ず操作内容を確認してください。フィードバックがある場合や、より多くのツールをご覧になりたい場合は、mcp@omise.coまでメールでお問い合わせください。

ログ設定

変数 説明 必須 デフォルト
LOG_LEVEL ログレベル - info debug、info、warn、error
LOG_FORMAT ログ出力形式 - simple json、simple
LOG_REQUESTS リクエストをログに記録 - true true、false
LOG_RESPONSES レスポンスをログに記録 - false true、false

レート制限設定

変数 説明 必須 デフォルト
RATE_LIMIT_ENABLED レート制限を有効化 - true true、false
RATE_LIMIT_MAX_REQUESTS ウィンドウあたりの最大リクエスト数 - 100 500
RATE_LIMIT_WINDOW_MS レート制限ウィンドウ(ミリ秒) - 60000 60000 (1分)

利用可能なツール

Omise MCPサーバーは、Omise APIの機能にアクセスするための包括的なツールセットを提供します。各ツールは特定のAPIエンドポイントに対応し、決済、顧客、および関連リソースの管理を可能にします。

OMISE MCP

Next-Generation Payment Infrastructure

50
Total API Tools
12
API Categories
4
Avg per Category

Charges

7 TOOLS
create_charge
支払い処理のための課金を作成
retrieve_charge
IDで課金情報を取得
list_charges
オプションのフィルタリング機能付きで全ての課金をリスト表示
update_charge
課金情報を更新(保留中の課金のみ)
capture_charge
承認済み課金をキャプチャ(部分/複数回キャプチャをサポート)
reverse_charge
承認済み課金を取り消し
expire_charge
保留中の課金を期限切れにする
👥

Customers

5 TOOLS
create_customer
顧客を作成
retrieve_customer
IDで顧客情報を取得
list_customers
フィルタリングオプション付きで全ての顧客をリスト表示
update_customer
顧客情報を更新
destroy_customer
顧客を削除
💳

Cards

4 TOOLS
list_customer_cards
顧客の全てのカードをリスト表示
retrieve_customer_card
顧客の特定のカードを取得
update_customer_card
顧客のカードを更新
destroy_customer_card
顧客を削除 card
🔐

Tokens

2 TOOLS
create_token
安全な支払い処理のためのカードトークンを作成
retrieve_token
IDでトークン情報を取得
🎯

Sources

2 TOOLS
create_source
各種支払い方法のための支払いソースを作成
retrieve_source
IDでソース情報を取得
💸

Transfers

5 TOOLS
create_transfer
受取人への振込を作成
retrieve_transfer
IDで振込情報を取得
list_transfers
オプションのフィルタリング機能付きで全ての振込をリスト表示
update_transfer
振込情報を更新(保留中の振込のみ)
destroy_transfer
振込を削除(保留中の振込のみ)
🎁

Recipients

6 TOOLS
create_recipient
振込用の受取人を作成
retrieve_recipient
IDで受取人情報を取得
list_recipients
オプションのフィルタリング機能付きで全ての受取人をリスト表示
update_recipient
受取人情報を更新
destroy_recipient
受取人を削除
verify_recipient
受取人情報と銀行口座を確認
↩️

Refunds

3 TOOLS
create_refund
課金の払い戻しを作成
retrieve_refund
IDで払い戻し情報を取得
list_refunds
オプションのフィルタリング機能付きで全ての払い戻しをリスト表示
⚠️

Disputes

8 TOOLS
list_disputes
オプションのフィルタリング機能付きで全ての異議申し立てをリスト表示
retrieve_dispute
IDで異議申し立て情報を取得
accept_dispute
異議申し立てを受け入れる(チャージバックを受け入れる)
update_dispute
異議申し立て情報を更新
list_dispute_documents
異議申し立ての全てのドキュメントをリスト表示
retrieve_dispute_document
特定の異議申し立てドキュメントを取得
upload_dispute_document
異議申し立てのドキュメントをアップロード
destroy_dispute_document
異議申し立てドキュメントを削除
📅

Schedules

5 TOOLS
create_schedule
支払いスケジュールを作成
retrieve_schedule
IDでスケジュール情報を取得
list_schedules
オプションのフィルタリング機能付きで全てのスケジュールをリスト表示
destroy_schedule
スケジュールを削除
list_schedule_occurrences
スケジュールの全ての発生履歴(実行履歴)をリスト表示
📡

Events

2 TOOLS
list_events
オプションのフィルタリング機能付きで全てのイベントをリスト表示
retrieve_event
IDでイベント情報を取得
🔧

Capability

1 TOOL
retrieve_capability
Omise APIの機能とサポートされている機能を取得

決済方法

Omise MCPサーバーは、Omise APIを通じて利用可能な幅広い決済方法をサポートしています:

  • クレジット/デビットカード: Visa、Mastercard、JCB
  • インターネットバンキング: バンコク銀行、カシコン銀行、サイアム商業銀行、クルンタイ銀行など
  • モバイルバンキング: PromptPay、TrueMoney Wallet
  • Eウォレット: Alipay、Alipay HK
  • 分割払い: 月次払いを提供する各種銀行

サポートされている決済方法の完全なリストと国別の利用可能性については、retrieve_capabilityツールを使用してください。

セキュリティのベストプラクティス

Omise MCPサーバーを使用する際:

  1. 開発中はテストキーを使用: 開発およびテスト中は常にテストモードのAPIキー(skey_test_およびpkey_test_で始まる)を使用してください。
  2. APIキーを保護: APIキーをバージョン管理にコミットしたり、公開したりしないでください。環境変数として保存してください。
  3. 適切なエラー処理を実装: 常にエラーを適切に処理し、エラーメッセージで機密情報を公開しないでください。
  4. 不審なアクティビティを監視: API使用状況を定期的に確認し、異常なパターンに対するアラートを設定してください。
  5. 本番環境でツールホワイトリストを使用: TOOLS=allを使用する代わりに、アプリケーションに必要なツールのみを指定してください。これは最小権限の原則に従い、攻撃対象領域を削減します。

エラー処理

Omise MCPサーバーは、API呼び出しが失敗した場合に詳細なエラー情報を提供します。例:

{
  "error": {
    "object": "error",
    "location": "https://docs.omise.co/api-errors",
    "code": "invalid_card",
    "message": "number is invalid"
  }
}

一般的なエラーコード:

  • authentication_failure - 無効なAPIキー
  • invalid_card - カード検証失敗
  • insufficient_fund - 操作に十分な残高がない
  • failed_processing - 決済処理失敗
  • invalid_charge - 無効なチャージパラメータ
  • not_found - リソースが見つからない
  • service_not_available - サービス一時的に利用不可

エラーコードの完全なリストについては、Omise APIエラードキュメントを参照してください。

テスト

テストモード

すべてのOmiseアカウントはデフォルトでテストモードが有効になっています。テストAPIキーを使用して、実際の決済を処理することなくトランザクションをシミュレートします。

テストカード

テストモードで以下のテストカード番号を使用します:

成功するチャージ: - 4242424242424242 - Visa - 5555555555554444 - Mastercard - 3530111333300000 - JCB

失敗するチャージ: - 4000000000000002 - カード拒否 - 4000000000000069 - 期限切れカード - 4000000000000127 - 誤ったCVC

テストカードと失敗シナリオの完全なリストについては、Omiseテストガイドを参照してください。

APIバージョン管理

Omise APIは後方互換性を確保するためにバージョン管理を使用しています。現在推奨されているバージョンは2019-05-29です。

特定のAPIバージョンを使用するには、OMISE_API_VERSION環境変数を設定します:

OMISE_API_VERSION=2019-05-29

詳細については、Omise APIバージョン管理ドキュメントを参照してください。

Claudeでの使用例

TOKENを使用したチャージの作成

チャージの作成

チャージの作成

チャージの作成と返金

チャージの返金

チャージの返金

利用可能なツールの一覧表示

利用可能なツールの一覧

サポート

問題が発生した場合や質問がある場合:

関連情報

Omiseは、お客様のウェブサイト全般における利便性を向上するためにクッキーを利用し、お客様のアクセス、閲覧履歴に関する情報を収集します。 当社のウェブサイトを閲覧し続けることにより、お客様は当社のプライバシーポリシーに同意することとします。 詳細はこちら