MCP Tools Reference: paydeveloper.googleapis.com

ツール: list_principals

特定の販売者にアクセスできるプリンシパル(ユーザー)を一覧表示します。この操作を行うには、販売者に対する管理者権限が必要です。

次のコードサンプルは、curl を使用して list_principals MCP ツールを呼び出す方法を示しています。

Curl リクエスト
curl --location 'https://paydeveloper.googleapis.com/mcp' \
--header 'content-type: application/json' \
--header 'accept: application/json, text/event-stream' \
--data '{
  "method": "tools/call",
  "params": {
    "name": "list_principals",
    "arguments": {
      // Provide these details according to the MCP tool specification.
    }
  },
  "jsonrpc": "2.0",
  "id": 1
}'

入力スキーマ

販売者のプリンシパルを一覧表示するためのリクエスト メッセージ。

ListPrincipalsRequest

JSON 表現
{
  "merchantId": string
}
フィールド
merchantId

string

必須。プリンシパルを一覧表示する販売者の ID。

出力スキーマ

販売者のプリンシパルを一覧表示するためのレスポンス メッセージ。

ListPrincipalsResponse

JSON 表現
{
  "principals": [
    {
      object (Principal)
    }
  ]
}
フィールド
principals[]

object (Principal)

販売者にアクセスできるプリンシパル。

プリンシパル

JSON 表現
{
  "email": string,
  "displayName": string,
  "role": enum (PrincipalRole),
  "state": enum (State)
}
フィールド
email

string

必須。プリンシパルのメールアドレス。

displayName

string

出力専用。プリンシパルの表示名。

role

enum (PrincipalRole)

販売者におけるプリンシパルのロール。

state

enum (State)

出力専用。販売者におけるプリンシパルのアクセス状態。

PrincipalRole

販売者でプリンシパル(ユーザー)に付与できるロール。

列挙型
PRINCIPAL_ROLE_UNSPECIFIED ロールが指定されていません。
ADMIN ユーザーの管理など、販売者に対する完全なアクセス権。
DEVELOPER 販売者と統合するデベロッパー向けのアクセス権。

販売者におけるプリンシパルのアクセス状態。

列挙型
STATE_UNSPECIFIED アクセス状態が指定されていません。
ACTIVE プリンシパルには、アクティブで承認済みのアクセス権があります。
PENDING プリンシパルは招待されていますが、まだ招待を承諾していません。
EXPIRED プリンシパルの招待が期限切れになりました。

ツールのアノテーション

ツールのアノテーションは、特定のツールの基本的なリスクを説明するために MCP クライアントに送信されます。ほとんどのクライアントはこれらのヒントを信頼できないものとして扱いますが、確認プロンプトをユーザーに送信するタイミングを判断するために使用できます。

タイトル文字列とともに、次のブール値のヒントが次のように定義されます。

  • readOnlyHint: true の場合、ツールはその環境を変更しません。デフォルトは false です。
  • destructiveHint: true の場合、ツールは破壊的なアクションを実行できます。false の場合、ツールは追加アクションのみを実行できます。デフォルト値は true です。
  • idempotentHint: true の場合、同じ引数でツールを繰り返し呼び出しても、環境に追加の影響はありません。デフォルトは false です。
  • openWorldHint: true の場合、ツールは外部エンティティの「オープン ワールド」とやり取りできます。false の場合、ツールは内部エンティティとのみやり取りできます。たとえば、ウェブ検索ツールはオープン ワールドですが、メモリツールはオープン ワールドではありません。

破壊的ヒント: ❌ | べき等ヒント: ✅ | 読み取り専用ヒント: ✅ | オープン ワールド ヒント: ❌