MCP Tools Reference: paydeveloper.googleapis.com

Strumento: list_principals

Elenca le entità (utenti) che hanno accesso a un commerciante specifico. Questa operazione richiede l'accesso come amministratore per il commerciante.

Il seguente esempio di codice mostra come utilizzare curl per chiamare lo strumento MCP list_principals.

Richiesta 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
}'

Schema di input

Messaggio di richiesta per elencare le entità di un commerciante.

ListPrincipalsRequest

Rappresentazione JSON 
{
  "merchantId": string
}
Campi
merchantId

string

Obbligatorio. L'ID commerciante per il quale elencare le entità.

Schema di output

Messaggio di risposta per elencare le entità di un commerciante.

ListPrincipalsResponse

Rappresentazione JSON 
{
  "principals": [
    {
      object (Principal)
    }
  ]
}
Campi
principals[]

object (Principal)

Le entità che hanno accesso al commerciante.

Entità

Rappresentazione JSON 
{
  "email": string,
  "displayName": string,
  "role": enum (PrincipalRole),
  "state": enum (State)
}
Campi
email

string

Obbligatorio. L'indirizzo email dell'entità.
displayName

string

Solo output. Il nome visualizzato dell'entità.
role

enum (PrincipalRole)

Il ruolo dell'entità sul commerciante.
state

enum (State)

Solo output. Lo stato di accesso dell'entità sul commerciante.

PrincipalRole

Un ruolo che può essere concesso a un'entità (utente) su un commerciante.

Enum
PRINCIPAL_ROLE_UNSPECIFIED Il ruolo non è specificato.
ADMIN Accesso completo al commerciante, inclusa la gestione degli utenti.
DEVELOPER Accesso destinato agli sviluppatori che si integrano con il commerciante.

Stato

Lo stato di accesso di un'entità su un commerciante.

Enum
STATE_UNSPECIFIED Lo stato di accesso non è specificato.
ACTIVE L'entità ha un accesso attivo e accettato.
PENDING L'entità è stata invitata, ma non ha ancora accettato l'invito.
EXPIRED L'invito dell'entità è scaduto.

Annotazioni dello strumento

Le annotazioni dello strumento vengono inviate ai client MCP per descrivere il rischio di base di un determinato strumento. La maggior parte dei client considera questi suggerimenti non attendibili, ma possono essere utilizzati per decidere quando inviare un prompt di conferma a un utente.

Oltre alla stringa del titolo, i seguenti suggerimenti booleani sono definiti come segue:

  • readOnlyHint: se è true, lo strumento non modifica il suo ambiente. Valore predefinito: false.
  • destructiveHint: se è true, lo strumento può eseguire azioni distruttive. Se è false, lo strumento può eseguire solo azioni additive. Valore predefinito: true.
  • idempotentHint: se è true, la chiamata ripetuta dello strumento con gli stessi argomenti non avrà alcun effetto aggiuntivo sul suo ambiente. Valore predefinito: false.
  • openWorldHint: se è true, lo strumento può interagire con un "open world" di entità esterne. Se è false, lo strumento può interagire solo con le entità interne. Ad esempio, uno strumento di ricerca web sarebbe open world, mentre uno strumento di memoria non lo sarebbe.

Suggerimento distruttivo: ❌ | Suggerimento idempotente: ✅ | Suggerimento di sola lettura: ✅ | Suggerimento open world: ❌