MCP Tools Reference: gmailmcp.googleapis.com

Ferramenta: list_labels

Lista todos os marcadores definidos pelo usuário disponíveis na conta do Gmail do usuário autenticado. Use essa ferramenta para descobrir o id de um marcador de usuário antes de chamar label_thread, unlabel_thread, label_message ou unlabel_message. Os marcadores do sistema não são retornados por essa ferramenta, mas podem ser usados com os IDs conhecidos: "INBOX", "TRASH", "SPAM", "STARRED", "UNREAD", "IMPORTANT", "CHAT", "DRAFT", "SENT".

O exemplo a seguir demonstra como usar curl para invocar a ferramenta MCP list_labels.

Solicitação do Curl
curl --location 'https://gmailmcp.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_labels",
    "arguments": {
      // provide these details according to the tool's MCP specification
    }
  },
  "jsonrpc": "2.0",
  "id": 1
}'
                

Esquema de entrada

Mensagem de solicitação para ListLabels RPC.

ListLabelsRequest

Representação JSON
{

  "pageSize": integer

  "pageToken": string
}
Campos

Campo de união _page_size.

_page_size pode ser apenas de um dos tipos a seguir:

pageSize

integer

Opcional. O número máximo de marcadores a serem retornados.

Campo de união _page_token.

_page_token pode ser apenas de um dos tipos a seguir:

pageToken

string

Opcional. Token de página para recuperar uma página específica de resultados na lista.

Esquema de saída

Mensagem de resposta para ListLabels RPC.

ListLabelsResponse

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

object (Label)

Lista de marcadores de usuário na conta do usuário.

nextPageToken

string

Token para recuperar a próxima página de resultados na lista.

Marcador

Representação JSON
{
  "labelId": string,
  "name": string,
  "color": {
    object (LabelColor)
  },

  "threadsTotal": integer

  "threadsUnread": integer
}
Campos
labelId

string

O identificador exclusivo do marcador.

name

string

O nome de exibição legível do marcador.

color

object (LabelColor)

Opcional. A cor do marcador.

Campo de união _threads_total.

_threads_total pode ser apenas de um dos tipos a seguir:

threadsTotal

integer

O número total de linhas de execução no marcador.

Campo de união _threads_unread.

_threads_unread pode ser apenas de um dos tipos a seguir:

threadsUnread

integer

O número de linhas de execução não lidas no marcador.

LabelColor

Representação JSON
{
  "textColor": string,
  "backgroundColor": string
}
Campos
textColor

string

A cor do texto do marcador, representada como uma string hexadecimal (por exemplo, "#000000"). Somente o seguinte conjunto predefinido de valores de cor é permitido: #000000, #434343, #666666, #999999, #cccccc, #efefef, #f3f3f3, #ffffff, #fb4c2f, #ffad47, #fad165, #16a766, #43d692, #4a86e8, #a479e2, #f691b3, #f6c5be, #ffe6c7, #fef1d1, #b9e4d0, #c6f3de, #c9daf8, #e4d7f5, #fcdee8, #efa093, #ffd6a2, #fce8b3, #89d3b2, #a0eac9, #a4c2f4, #d0bcf1, #fbc8d9, #e66550, #ffbc6b, #fcda83, #44b984, #68dfa9, #6d9eeb, #b694e8, #f7a7c0, #cc3a21, #eaa041, #f2c960, #149e60, #3dc789, #3c78d8, #8e63ce, #e07798, #ac2b16, #cf8933, #d5ae49, #0b804b, #2a9c68, #285bac, #653e9b, #b65775, #822111, #a46a21, #aa8831, #076239, #1a764d, #1c4587, #41236d, #83334c, #464646, #e7e7e7, #0d3472, #b6cff5, #0d3b44, #98d7e4, #3d188e, #e3d7ff, #711a36, #fbd3e0, #8a1c0a, #f2b2a8, #7a2e0b, #ffc8af, #7a4706, #ffdeb5, #594c05, #fbe983, #684e07, #fdedc1, #0b4f30, #b3efd3, #04502e, #a2dcc1, #c2c2c2, #4986e7, #2da2bb, #b99aff, #994a64, #f691b2, #ff7537, #ffad46, #662e37, #ebdbde, #cca6ac, #094228, #42d692, #16a765

backgroundColor

string

A cor de plano de fundo do marcador, representada como uma string hexadecimal (por exemplo, "#ffffff"). Somente o seguinte conjunto predefinido de valores de cor é permitido: #000000, #434343, #666666, #999999, #cccccc, #efefef, #f3f3f3, #ffffff, #fb4c2f, #ffad47, #fad165, #16a766, #43d692, #4a86e8, #a479e2, #f691b3, #f6c5be, #ffe6c7, #fef1d1, #b9e4d0, #c6f3de, #c9daf8, #e4d7f5, #fcdee8, #efa093, #ffd6a2, #fce8b3, #89d3b2, #a0eac9, #a4c2f4, #d0bcf1, #fbc8d9, #e66550, #ffbc6b, #fcda83, #44b984, #68dfa9, #6d9eeb, #b694e8, #f7a7c0, #cc3a21, #eaa041, #f2c960, #149e60, #3dc789, #3c78d8, #8e63ce, #e07798, #ac2b16, #cf8933, #d5ae49, #0b804b, #2a9c68, #285bac, #653e9b, #b65775, #822111, #a46a21, #aa8831, #076239, #1a764d, #1c4587, #41236d, #83334c, #464646, #e7e7e7, #0d3472, #b6cff5, #0d3b44, #98d7e4, #3d188e, #e3d7ff, #711a36, #fbd3e0, #8a1c0a, #f2b2a8, #7a2e0b, #ffc8af, #7a4706, #ffdeb5, #594c05, #fbe983, #684e07, #fdedc1, #0b4f30, #b3efd3, #04502e, #a2dcc1, #c2c2c2, #4986e7, #2da2bb, #b99aff, #994a64, #f691b2, #ff7537, #ffad46, #662e37, #ebdbde, #cca6ac, #094228, #42d692, #16a765

Anotações de ferramentas

Dica destrutiva: ❌ | Dica idempotente: ✅ | Dica somente leitura: ✅ | Dica de mundo aberto: ❌

Escopos de autorização

Requer um dos seguintes escopos do OAuth:

  • https://mail.google.com/
  • https://www.googleapis.com/auth/gmail.modify
  • https://www.googleapis.com/auth/gmail.readonly
  • https://www.googleapis.com/auth/gmail.labels
  • https://www.googleapis.com/auth/gmail.metadata