MCP Tools Reference: chatmcp.googleapis.com

Ferramenta: list_memberships

Lista as assinaturas em uma conversa do Google Chat.

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

Solicitação Curl 
curl --location 'https://chatmcp.googleapis.com/mcp/v1' \
--header 'Authorization: Bearer YOUR_ACCESS_TOKEN' \
--header 'content-type: application/json' \
--header 'accept: application/json, text/event-stream' \
--data '{
  "method": "tools/call",
  "params": {
    "name": "list_memberships",
    "arguments": {
      // Provide these details according to the MCP tool specification.
    }
  },
  "jsonrpc": "2.0",
  "id": 1
}'

Esquema de entrada

ListMembershipsRequest

Representação JSON 
{
  "conversationId": string,
  "pageSize": integer,
  "pageToken": string,
  "membershipFilter": enum (MembershipFilter)
}
Campos
conversationId

string

Obrigatório. O ID da conversa para listar as assinaturas. Formato: spaces/{space}
pageSize

integer

Opcional. O número máximo de assinaturas a serem retornadas. O serviço pode retornar um valor inferior a este. Se não for especificado ou definido como um valor não positivo, um valor padrão de 20 será usado. O valor máximo permitido é 50.
pageToken

string

Opcional. Um token de página, recebido de uma chamada list_memberships anterior. Forneça isso para recuperar a página subsequente.
membershipFilter

enum (MembershipFilter)

Opcional. Especifica o subconjunto de assinaturas a serem retornadas. Se não for especificado, apenas as assinaturas JOINED serão retornadas.

MembershipFilter

Especifica o subconjunto de assinaturas a serem retornadas.

Tipos enumerados
MEMBERSHIP_FILTER_UNSPECIFIED Valor padrão. Se não for especificado, retorna apenas as assinaturas JOINED.
JOINED_ONLY Retorna apenas as assinaturas JOINED.
JOINED_AND_INVITED Retorna as assinaturas JOINED e INVITED.

Esquema de saída

Resposta que contém a lista de assinaturas na conversa.

ListMembershipsResponse

Representação JSON 
{
  "memberships": [
    {
      object (Membership)
    }
  ],
  "nextPageToken": string
}
Campos
memberships[]

object (Membership)

Lista de assinaturas na conversa solicitada.
nextPageToken

string

Um token que pode ser enviado como page_token para recuperar a próxima página. Se esse campo for omitido, não haverá páginas subsequentes.

Assinatura

Representação JSON 
{
  "member": {
    object (User)
  },
  "state": enum (State),
  "role": enum (Role)
}
Campos
member

object (User)

O usuário que é membro.
state

enum (State)

Apenas saída. Estado da assinatura.
role

enum (Role)

Papel do membro.

Usuário

Representação JSON 
{
  "userId": string,
  "displayName": string,
  "email": string,
  "userType": enum (UserType)
}
Campos
userId

string

Nome do recurso de um usuário do Chat. Formato: users/{user}.
displayName

string

O nome de exibição de um usuário do Chat.
email

string

O endereço de e-mail do usuário. Esse campo só é preenchido quando o tipo de usuário é HUMAN.
userType

enum (UserType)

O tipo de usuário.

UserType

O tipo de usuário do Google Chat.

Tipos enumerados
USER_TYPE_UNSPECIFIED Não especificado.
HUMAN Usuário humano.
APP Usuário do app.

Estado

Estado da assinatura.

Tipos enumerados
STATE_UNSPECIFIED Não especificado.
JOINED O usuário é membro do espaço.
INVITED O usuário foi convidado para participar do espaço.

Papel

Papel do membro.

Tipos enumerados
ROLE_UNSPECIFIED Não especificado.
MEMBER O usuário é membro do espaço.
MANAGER O usuário é um administrador do espaço.
ASSISTANT_MANAGER O usuário é um administrador assistente do espaço.

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á nenhum 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: ❌

Escopos de autorização

Requer um dos seguintes escopos do OAuth:

  • https://www.googleapis.com/auth/chat.memberships
  • https://www.googleapis.com/auth/chat.memberships.readonly