MCP Tools Reference: paydeveloper.googleapis.com

Ferramenta: list_principals

Lista os principais (usuários) que têm acesso a um comerciante específico. 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 list_principals.

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": "list_principals",
    "arguments": {
      // Provide these details according to the MCP tool specification.
    }
  },
  "jsonrpc": "2.0",
  "id": 1
}'

Esquema de entrada

Mensagem de solicitação para listar os principais de um comerciante.

ListPrincipalsRequest

Representação JSON 
{
  "merchantId": string
}
Campos
merchantId

string

Obrigatório. O ID do comerciante para o qual listar os principais.

Esquema de saída

Mensagem de resposta para listar os principais de um comerciante.

ListPrincipalsResponse

Representação JSON 
{
  "principals": [
    {
      object (Principal)
    }
  ]
}
Campos
principals[]

object (Principal)

Os principais que têm acesso ao comerciante.

Principal

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

string

Obrigatório. O endereço de e-mail do principal.
displayName

string

Apenas saída. O nome de exibição do principal.
role

enum (PrincipalRole)

O papel do principal no comerciante.
state

enum (State)

Apenas saída. O estado de acesso do principal no comerciante.

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 a integração com o comerciante.

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á executar ações destrutivas. Se for falso, a ferramenta só poderá executar 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: ❌