MCP Tools Reference: paydeveloper.googleapis.com

Ferramenta: set_principal_role

Define o papel de um principal (usuário) em um comerciante ou adiciona um novo principal com o papel especificado. O principal recebe um convite por e-mail e precisa aceitá-lo para que o acesso seja ativado. Essa operação requer acesso de administrador para o comerciante.

O exemplo de código a seguir mostra como usar curl para chamar a ferramenta MCP set_principal_role.

Solicitação 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
}'

Esquema de entrada

Mensagem de solicitação para adicionar ou atualizar um principal em um comerciante.

SetPrincipalRoleRequest

Representação JSON 
{
  "merchantId": string,
  "email": string,
  "role": enum (PrincipalRole)
}
Campos
merchantId

string

Obrigatório. O ID do comerciante para o qual adicionar ou atualizar o principal.
email

string

Obrigatório. O endereço de e-mail do principal a ser adicionado ou atualizado.
role

enum (PrincipalRole)

Obrigatório. O papel a ser concedido ao principal.

PrincipalRole

Um papel que pode ser concedido a um principal (usuário) em um comerciante.

Tipos enumerados
PRINCIPAL_ROLE_UNSPECIFIED O papel não foi especificado.
ADMIN Acesso total ao comerciante, incluindo o gerenciamento de usuários.
DEVELOPER Acesso destinado a desenvolvedores que fazem integração com o comerciante.

Esquema de saída

Mensagem de resposta para adicionar ou atualizar um principal em um comerciante.

SetPrincipalRoleResponse

Representação JSON 
{
  "state": enum (State)
}
Campos
state

enum (State)

O estado do principal após a adição ou atualização.

Estado

O estado do acesso de um principal em um comerciante.

Tipos enumerados
STATE_UNSPECIFIED O estado de acesso não foi especificado.
ACTIVE O principal tem um acesso ativo e aceito.
PENDING O principal foi convidado, mas ainda não aceitou o convite.
EXPIRED O convite do principal expirou.

Anotações da ferramenta

As anotações da ferramenta são enviadas aos clientes do MCP para descrever o risco básico de uma determinada ferramenta. A maioria dos clientes trata essas dicas como não confiáveis, mas elas podem ser usadas para decidir quando um prompt de confirmação pode ser enviado a um usuário.

Além da string de título, as seguintes dicas booleanas são definidas da seguinte maneira:

  • readOnlyHint: se for verdadeiro, a ferramenta não modifica o ambiente. Padrão: falso.
  • destructiveHint: se for verdadeiro, a ferramenta poderá realizar ações destrutivas. Se for falso, a ferramenta só poderá realizar ações aditivas. Padrão: verdadeiro.
  • idempotentHint: se for verdadeiro, chamar a ferramenta repetidamente com os mesmos argumentos não terá efeito adicional no ambiente. Padrão: falso.
  • openWorldHint: se for verdadeiro, a ferramenta poderá interagir com um "mundo aberto" de entidades externas. Se for falso, a ferramenta só poderá interagir com entidades internas. Por exemplo, uma ferramenta de pesquisa na Web seria de mundo aberto, enquanto uma ferramenta de memória não seria.

Dica destrutiva: ✅ | Dica idempotente: ❌ | Dica somente leitura: ❌ | Dica de mundo aberto: ❌