工具: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,则该工具只能与内部实体互动。例如,网络搜索工具属于开放世界,而内存工具则不属于开放世界。
破坏性提示:❌ | 等幂性提示:✅ | 只读提示:✅ | 开放世界提示:❌