MCP Tools Reference: paydeveloper.googleapis.com

Herramienta: list_principals

Muestra una lista de las principales (usuarios) que tienen acceso a un comercio específico. Para esta operación, se requiere acceso de administrador para el comercio.

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

Solicitud 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

Es un mensaje de solicitud para mostrar las principales de un comercio.

ListPrincipalsRequest

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

string

Obligatorio. Es el ID del comercio para el que se mostrarán las principales.

Esquema de salida

Es un mensaje de respuesta para mostrar las principales de un comercio.

ListPrincipalsResponse

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

object (Principal)

Son las principales que tienen acceso al comercio.

Principal

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

string

Obligatorio. Es la dirección de correo electrónico de la principal.
displayName

string

Solo salida. Es el nombre visible de la principal.
role

enum (PrincipalRole)

Es el rol de la principal en el comercio.
state

enum (State)

Solo salida. Es el estado de acceso de la principal en el comercio.

PrincipalRole

Es un rol que se puede otorgar a una principal (usuario) en un comercio.

Enums
PRINCIPAL_ROLE_UNSPECIFIED El rol no está especificado.
ADMIN Acceso completo al comercio, incluida la administración de usuarios.
DEVELOPER Acceso destinado a los desarrolladores que se integran con el comercio.

Estado

Es el estado del acceso de una principal en un comercio.

Enums
STATE_UNSPECIFIED El estado de acceso no está especificado.
ACTIVE La principal tiene un acceso activo y aceptado.
PENDING Se invitó a la principal, pero aún no aceptó la invitación.
EXPIRED Venció la invitación de la principal.

Anotaciones de herramientas

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

Junto con la cadena de título, las siguientes sugerencias booleanas se definen de la siguiente manera:

  • readOnlyHint: Si es verdadero, la herramienta no modifica su entorno. Valor predeterminado: false.
  • destructiveHint: Si es verdadero, la herramienta puede realizar acciones destructivas. Si es falso, la herramienta solo puede realizar acciones aditivas. Valor predeterminado: true.
  • idempotentHint: Si es verdadero, llamar a la herramienta de forma repetida con los mismos argumentos no tendrá ningún efecto adicional en su entorno. Valor predeterminado: false.
  • openWorldHint: Si es verdadero, la herramienta puede interactuar con un "mundo abierto" de entidades externas. Si es falso, la herramienta solo puede 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.

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