MCP Tools Reference: paydeveloper.googleapis.com

Herramienta: list_principals

Muestra las entidades principales (usuarios) que tienen acceso a un comerciante específico. Esta operación requiere que el comerciante tenga acceso de administrador.

En el siguiente código de ejemplo se muestra cómo usar curl para llamar a la herramienta list_principals de MCP.

Curl Request 
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

Mensaje de solicitud para enumerar las entidades de un comerciante.

ListPrincipalsRequest

Representación JSON 
{
  "merchantId": string
}
Campos
merchantId

string

Obligatorio. El ID de comerciante del que se deben enumerar los principales.

Esquema de salida

Mensaje de respuesta para enumerar las entidades de un comercio.

ListPrincipalsResponse

Representación JSON 
{
  "principals": [
    {
      object (Principal)
    }
  ]
}
Campos
principals[]

object (Principal)

Las entidades que tienen acceso al comerciante.

Entidad

Representación JSON 
{
  "email": string,
  "displayName": string,
  "role": enum (PrincipalRole),
  "state": enum (State)
}
Campos
email

string

Obligatorio. La dirección de correo electrónico del director.
displayName

string

Solo de salida. Nombre visible de la entidad de seguridad.
role

enum (PrincipalRole)

El rol de la cuenta principal en el comerciante.
state

enum (State)

Solo de salida. Estado de acceso de la entidad de seguridad en el comerciante.

PrincipalRole

Rol que se puede asignar a una entidad (usuario) en un comerciante.

enumeraciones,
PRINCIPAL_ROLE_UNSPECIFIED El rol no se ha especificado.
ADMIN Acceso completo al comerciante, incluida la gestión de usuarios.
DEVELOPER Acceso destinado a los desarrolladores que se integran con el comerciante.

Estado

Estado del acceso de una entidad a un comerciante.

enumeraciones,
STATE_UNSPECIFIED El estado de acceso no está especificado.
ACTIVE La entidad tiene un acceso activo y aceptado.
PENDING Se ha invitado al centro, pero aún no ha aceptado la invitación.
EXPIRED La invitación del centro ha caducado.

Anotaciones de herramientas

Las anotaciones de herramientas se envían a los clientes de MCP para describir el riesgo básico de una herramienta concreta. La mayoría de los clientes tratan estas sugerencias como no fiables, pero se pueden usar para decidir cuándo se puede enviar una petición de confirmación a un usuario.

Además de la cadena del título, se definen las siguientes sugerencias booleanas:

  • readOnlyHint: si es true, la herramienta no modifica su entorno. Valor predeterminado: false.
  • destructiveHint: si es true, la herramienta puede realizar acciones destructivas. Si es false, la herramienta solo puede realizar acciones aditivas. Valor predeterminado: true.
  • idempotentHint: si es true, llamar a la herramienta repetidamente con los mismos argumentos no tendrá ningún efecto adicional en su entorno. Valor predeterminado: false.
  • openWorldHint: si es true, la herramienta puede interactuar con un "mundo abierto" de entidades externas. Si es false, la herramienta solo podrá interactuar con entidades internas. Por ejemplo, una herramienta de búsqueda web sería de mundo abierto, mientras que una herramienta de memoria no lo sería.

Pista destructiva: ❌ | Pista idempotente: ✅ | Pista de solo lectura: ✅ | Pista de mundo abierto: ❌