MCP Tools Reference: paydeveloper.googleapis.com

工具:set_principal_role

设置主账号(用户)在商家中的角色,或添加具有指定角色的新主账号。系统会向主账号发送电子邮件邀请,主账号必须接受邀请,其访问权限才会生效。此操作需要商家管理员权限。

以下代码示例展示了如何使用 curl 调用 set_principal_role 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": "set_principal_role",
    "arguments": {
      // Provide these details according to the MCP tool specification.
    }
  },
  "jsonrpc": "2.0",
  "id": 1
}'

输入架构

用于在商家中添加或更新主账号的请求消息。

SetPrincipalRoleRequest

JSON 表示法
{
  "merchantId": string,
  "email": string,
  "role": enum (PrincipalRole)
}
字段
merchantId

string

必需。要为其添加或更新主账号的商家 ID。

email

string

必需。要添加或更新的主账号的电子邮件地址。

role

enum (PrincipalRole)

必需。要授予给主账号的角色。

PrincipalRole

可以授予给商家中的主账号(用户)的角色。

枚举
PRINCIPAL_ROLE_UNSPECIFIED 角色未指定。
ADMIN 拥有对商家的完全访问权限,包括管理用户。
DEVELOPER 供与商家集成的开发者使用的访问权限。

输出架构

用于在商家中添加或更新主账号的响应消息。

SetPrincipalRoleResponse

JSON 表示法
{
  "state": enum (State)
}
字段
state

enum (State)

添加或更新后主账号的状态。

State

主账号在商家中的访问权限状态。

枚举
STATE_UNSPECIFIED 访问权限状态未指定。
ACTIVE 主账号拥有已接受的有效访问权限。
PENDING 主账号已收到邀请,但尚未接受邀请。
EXPIRED 主账号的邀请已过期。

工具注释

工具注释会发送给 MCP 客户端,用于描述给定工具的基本风险。大多数客户端会将这些提示视为不受信任,但它们可用于确定何时向用户发送确认提示。

除了标题字符串之外,系统还定义了以下布尔值提示:

  • readOnlyHint:如果为 true,则表示该工具不会修改其环境。默认值:false。
  • destructiveHint:如果为 true,则表示该工具可以执行破坏性操作。如果为 false,则表示该工具只能执行添加操作。默认值:true。
  • idempotentHint:如果为 true,则表示使用相同的参数重复调用该工具不会对其环境产生额外影响。默认值:false。
  • openWorldHint:如果为 true,则表示该工具可以与外部实体的“开放世界”互动。如果为 false,则表示该工具只能与内部实体互动。例如,网络搜索工具属于开放世界,而内存工具则不属于开放世界。

破坏性提示:✅ | 幂等性提示:❌ | 只读提示:❌ | 开放世界提示:❌