MCP Tools Reference: gmailmcp.googleapis.com

Ferramenta: list_drafts

Lista os e-mails em rascunho da conta do Gmail do usuário autenticado.

Essa ferramenta pode filtrar rascunhos com base em uma string de consulta e é compatível com paginação. Ele retorna uma lista de rascunhos, incluindo IDs e assuntos (a menos que view esteja definido como DRAFT_VIEW_METADATA_ONLY). page_token pode ser usado para paginar os resultados. Para recuperar as próximas páginas de resultados, use o page_token retornado na resposta anterior.

O parâmetro view controla quais campos são preenchidos na resposta. Por padrão (ou com DRAFT_VIEW_FULL), ele retorna o conteúdo completo. Use DRAFT_VIEW_METADATA_ONLY para excluir conteúdo sensível, como assunto e corpo.

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

Solicitação 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_drafts",
    "arguments": {
      // provide these details according to the tool's MCP specification
    }
  },
  "jsonrpc": "2.0",
  "id": 1
}'

Esquema de entrada

Mensagem de solicitação para RPC ListDrafts.

ListDraftsRequest

Representação JSON 
{

  "pageSize": integer

  "pageToken": string

  "query": string

  "view": enum (DraftView)
}
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 rascunhos a serem retornados. Se não for especificado, o padrão será 20. O valor máximo permitido é 50.

Campo de união _page_token.

_page_token pode ser apenas de um dos tipos a seguir:
pageToken

string

Opcional. Um token recebido de uma chamada "list_drafts" anterior para recuperar a próxima página de resultados. Deixe em branco para buscar a primeira página. Isso é usado principalmente para paginação, para continuar buscando resultados de onde a chamada ListDraft anterior parou, especialmente quando o número de rascunhos que correspondem à consulta excede o limite de "page_size".

Campo de união _query.

_query pode ser apenas de um dos tipos a seguir:
query

string

Exemplos:

  • subject:OneMCP Update
  • from:gduser1@workspacesamples.dev
  • to:gduser2@workspacesamples.dev AND newer_than:7d
  • project proposal has:attachment
  • is:unread

Um espaço ou um traço (-) vai separar um número, e um ponto (.) vai indicar uma casa decimal. Por exemplo, 01.2047-100 é considerado dois números: 01.2047 e 100.

Observação: se quisermos garantir que todos os rascunhos da consulta sejam retornados, podemos paginar os resultados fazendo chamadas repetidas para a ferramenta até que a resposta contenha uma lista vazia de rascunhos.

Campo de união _view.

_view pode ser apenas de um dos tipos a seguir:
view

enum (DraftView)

Opcional. Controla os campos preenchidos para rascunhos na lista de rascunhos. Por padrão (ou com DRAFT_VIEW_FULL), ele retorna o conteúdo completo, que tem ID de rascunho, threadID, para, cc, cco, data, assunto e corpo. Use DRAFT_VIEW_METADATA_ONLY para excluir assunto e corpo.

DraftView

Enumeração para controlar os campos preenchidos para rascunhos na resposta "ListDrafts".

Tipos enumerados
DRAFT_VIEW_UNSPECIFIED Corresponde a DRAFT_VIEW_FULL para compatibilidade com versões anteriores.
DRAFT_VIEW_METADATA_ONLY Somente metadados: não inclui assunto, plaintext_body, html_body.
DRAFT_VIEW_FULL Metadados + UGC (comportamento padrão).

Esquema de saída

Mensagem de resposta para a RPC ListDrafts.

ListDraftsResponse

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

object (Draft)

Lista de rascunhos.
nextPageToken

string

Um token que pode ser usado em uma chamada subsequente para recuperar a próxima página de rascunhos. Se o número de rascunhos correspondentes à consulta exceder o limite de page_size, a resposta vai conter um next_page_token. Para recuperar a próxima página de resultados, transmita esse token no campo page_token do próximo ListDraftsRequest.

Rascunho

Representação JSON 
{
  "id": string,
  "subject": string,
  "threadId": string,
  "toRecipients": [
    string
  ],
  "ccRecipients": [
    string
  ],
  "bccRecipients": [
    string
  ],
  "plaintextBody": string,
  "date": string,
  "htmlBody": string
}
Campos
id

string

O identificador exclusivo do recurso de rascunho.
subject

string

A linha de assunto da mensagem em rascunho.
threadId

string

O ID da conversa a que este rascunho pertence.
toRecipients[]

string

Lista de endereços de e-mail de destinatários em "Para" extraídos dos cabeçalhos.
ccRecipients[]

string

Lista de endereços de e-mail de destinatários em "Cc" extraídos dos cabeçalhos.
bccRecipients[]

string

Lista de endereços de e-mail de destinatários em "Cco" extraídos dos cabeçalhos.
plaintextBody

string

Conteúdo do corpo de texto simples, se disponível.
date

string

Data do rascunho no formato ISO 8601 (AAAA-MM-DD).
htmlBody

string

O conteúdo do corpo HTML do rascunho, se disponível.

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.compose
  • https://www.googleapis.com/auth/gmail.readonly