工具: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 |
必填。要列出主體的商家 ID。 |
輸出內容的結構定義
列出商家負責人的回覆訊息。
ListPrincipalsResponse
| JSON 表示法 |
|---|
{
"principals": [
{
object ( |
| 欄位 | |
|---|---|
principals[] |
可存取商家的主體。 |
主體
| JSON 表示法 |
|---|
{ "email": string, "displayName": string, "role": enum ( |
| 欄位 | |
|---|---|
email |
必填。主體的電子郵件地址。 |
displayName |
僅供輸出。主體的顯示名稱。 |
role |
主體在商家中的角色。 |
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,工具只能與內部實體互動。舉例來說,網頁搜尋工具屬於開放世界,記憶體工具則不屬於開放世界。
破壞性提示:❌ | 等冪提示:✅ | 唯讀提示:✅ | 開放世界提示:❌