MCP Tools Reference: gmailmcp.googleapis.com

Narzędzie: list_drafts

Wyświetla listę wersji roboczych e-maili z konta Gmail uwierzytelnionego użytkownika.

To narzędzie może filtrować wersje robocze na podstawie ciągu zapytania i obsługuje paginację. Zwraca listę wersji roboczych, w tym ich identyfikatory i tematy (chyba że parametr view jest ustawiony na DRAFT_VIEW_METADATA_ONLY). Do paginacji wyników można użyć parametru page_token. Aby pobrać kolejne strony wyników, użyj parametru page_token zwróconego w poprzedniej odpowiedzi.

Parametr view określa, które pola mają być wypełniane w odpowiedzi. Domyślnie (lub w przypadku ustawienia DRAFT_VIEW_FULL) zwraca pełną treść. Aby wykluczyć treści o charakterze kontrowersyjnym, takie jak temat i treść, użyj ustawienia DRAFT_VIEW_METADATA_ONLY.

Poniższy przykład pokazuje, jak użyć narzędzia curl do wywołania narzędzia MCP list_drafts.

Żądanie 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
}'

Schemat wejściowy

Komunikat żądania dla RPC ListDrafts.

ListDraftsRequest

Zapis JSON 
{

  "pageSize": integer

  "pageToken": string

  "query": string

  "view": enum (DraftView)
}
Pola

Pole zbiorcze _page_size.

Pole _page_size może mieć tylko jedną z tych wartości:
pageSize

integer

Opcjonalnie. Maksymalna liczba wersji roboczych do zwrócenia. Jeśli nie podasz żadnej wartości, domyślnie zostanie użyta wartość 20. Maksymalna dozwolona wartość to 50.

Pole zbiorcze _page_token.

Pole _page_token może mieć tylko jedną z tych wartości:
pageToken

string

Opcjonalnie. Token otrzymany z poprzedniego wywołania list_drafts w celu pobrania następnej strony wyników. Aby pobrać pierwszą stronę, pozostaw to pole puste. Jest to używane głównie do paginacji, aby kontynuować pobieranie wyników od miejsca, w którym zakończyło się poprzednie wywołanie ListDraft, zwłaszcza gdy liczba wersji roboczych pasujących do zapytania przekracza limit page_size.

Pole zbiorcze _query.

Pole _query może mieć tylko jedną z tych wartości:
query

string

Przykłady:

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

Jeśli w zapytaniu używasz liczb, spacja lub łącznik (-) oddzielają dwie liczby, a kropka (.) to separator dziesiętny. Przykład: zapis 01.2047-100 będzie oznaczał dwie liczby: 01.2047 i 100.

Uwaga: jeśli chcesz mieć pewność, że zostaną zwrócone wszystkie wersje robocze pasujące do zapytania, możesz podzielić wyniki na strony, wykonując powtarzające się wywołania narzędzia, aż odpowiedź będzie zawierać pustą listę wersji roboczych.

Pole zbiorcze _view.

Pole _view może mieć tylko jedną z tych wartości:
view

enum (DraftView)

Opcjonalnie. Określa pola wypełniane w przypadku wersji roboczych na liście wersji roboczych. Domyślnie (lub w przypadku ustawienia DRAFT_VIEW_FULL) zwraca pełną treść, która zawiera identyfikator wersji roboczej, identyfikator wątku, pola do, dw, udw, datę, temat i treść. Aby wykluczyć temat i treść, użyj ustawienia DRAFT_VIEW_METADATA_ONLY.

DraftView

Wyliczenie określające pola wypełniane w przypadku wersji roboczych w odpowiedzi ListDrafts.

Wartości w polu enum
DRAFT_VIEW_UNSPECIFIED W celu zapewnienia zgodności wstecznej mapuje się na DRAFT_VIEW_FULL.
DRAFT_VIEW_METADATA_ONLY Tylko metadane: nie obejmuje tematu, plaintext_body, html_body.
DRAFT_VIEW_FULL Metadane + treści generowane przez użytkowników (domyślne działanie).

Schemat wyjściowy

Komunikat odpowiedzi dla RPC ListDrafts.

ListDraftsResponse

Zapis JSON 
{
  "drafts": [
    {
      object (Draft)
    }
  ],
  "nextPageToken": string
}
Pola
drafts[]

object (Draft)

Lista wersji roboczych.
nextPageToken

string

Token, którego można użyć w kolejnym wywołaniu, aby pobrać następną stronę wersji roboczych. Jeśli liczba wersji roboczych pasujących do zapytania przekracza limit page_size, odpowiedź będzie zawierać next_page_token. Aby pobrać następną stronę wyników, przekaż ten token w polu page_token następnego ListDraftsRequest.

Draft

Zapis JSON 
{
  "id": string,
  "subject": string,
  "threadId": string,
  "toRecipients": [
    string
  ],
  "ccRecipients": [
    string
  ],
  "bccRecipients": [
    string
  ],
  "plaintextBody": string,
  "date": string,
  "htmlBody": string
}
Pola
id

string

Unikalny identyfikator zasobu wersji roboczej.
subject

string

Wiersz tematu wiadomości w wersji roboczej.
threadId

string

Identyfikator wątku, do którego należy ta wersja robocza.
toRecipients[]

string

Lista adresów e-mail odbiorców w polu „Do” wyodrębnionych z nagłówków.
ccRecipients[]

string

Lista adresów e-mail odbiorców w polu „DW” wyodrębnionych z nagłówków.
bccRecipients[]

string

Lista adresów e-mail odbiorców w polu „UDW” wyodrębnionych z nagłówków.
plaintextBody

string

Treść w postaci zwykłego tekstu, jeśli jest dostępna.
date

string

Data wersji roboczej w formacie ISO 8601 (RRRR-MM-DD).
htmlBody

string

Treść wersji roboczej w formacie HTML, jeśli jest dostępna.

Adnotacje narzędzia

Wskazówka dotycząca działania destrukcyjnego: ❌ | Wskazówka dotycząca działania idempotentnego: ❌ | Wskazówka dotycząca działania tylko do odczytu: ✅ | Wskazówka dotycząca działania w otwartym świecie: ❌

Zakresy autoryzacji

Wymaga jednego z tych zakresów 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