MCP Tools Reference: gmailmcp.googleapis.com

Alat: list_drafts

Mencantumkan email draf dari akun Gmail pengguna yang diautentikasi.

Alat ini dapat memfilter draf berdasarkan string kueri dan mendukung penomoran halaman. Alat ini menampilkan daftar draf, termasuk ID dan subjeknya (kecuali jika view ditetapkan ke DRAFT_VIEW_METADATA_ONLY). page_token dapat digunakan untuk membuat penomoran halaman pada hasil. Untuk mengambil halaman hasil berikutnya, gunakan page_token yang ditampilkan dalam respons sebelumnya.

Parameter view mengontrol kolom mana yang diisi dalam respons. Secara default (atau dengan DRAFT_VIEW_FULL), parameter ini menampilkan konten lengkap. Gunakan DRAFT_VIEW_METADATA_ONLY untuk mengecualikan konten sensitif seperti subjek dan isi.

Contoh berikut menunjukkan cara menggunakan curl untuk memanggil alat MCP list_drafts.

Permintaan 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
}'

Skema Input

Pesan permintaan untuk ListDrafts RPC.

ListDraftsRequest

Representasi JSON 
{

  "pageSize": integer

  "pageToken": string

  "query": string

  "view": enum (DraftView)
}
Kolom

Kolom union _page_size.

_page_size hanya dapat berupa salah satu dari berikut:
pageSize

integer

Opsional. Jumlah maksimum draf yang akan ditampilkan. Jika tidak ditentukan, nilai defaultnya adalah 20. Nilai maksimum yang diizinkan adalah 50.

Kolom union _page_token.

_page_token hanya dapat berupa salah satu dari berikut:
pageToken

string

Opsional. Token yang diterima dari panggilan list_drafts sebelumnya untuk mengambil halaman hasil berikutnya. Biarkan kosong untuk mengambil halaman pertama. Token ini terutama digunakan untuk penomoran halaman guna terus mengambil hasil dari tempat panggilan ListDraft sebelumnya berhenti, terutama saat jumlah draf yang cocok dengan kueri melebihi batas page_size.

Kolom union _query.

_query hanya dapat berupa salah satu dari berikut:
query

string

Contoh:

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

Spasi atau tanda hubung (-) akan memisahkan angka, sedangkan tanda titik (.) akan menjadi desimal. Misalnya, 01.2047-100 dianggap sebagai dua angka: 01.2047 dan 100.

Catatan: Jika ingin memastikan semua draf untuk kueri ditampilkan, kita dapat membuat penomoran halaman pada hasil dengan melakukan panggilan berulang ke alat hingga respons berisi daftar draf kosong.

Kolom union _view.

_view hanya dapat berupa salah satu dari berikut:
view

enum (DraftView)

Opsional. Mengontrol kolom yang diisi untuk draf dalam daftar draf. Secara default (atau dengan DRAFT_VIEW_FULL), parameter ini menampilkan konten lengkap, yang memiliki ID draf, threadID, kepada, cc, bcc, tanggal, subjek, dan isi. Gunakan DRAFT_VIEW_METADATA_ONLY untuk mengecualikan subjek dan isi.

DraftView

Enum untuk mengontrol kolom yang diisi untuk draf dalam respons ListDrafts.

Enum
DRAFT_VIEW_UNSPECIFIED Dipetakan ke DRAFT_VIEW_FULL untuk kompatibilitas mundur.
DRAFT_VIEW_METADATA_ONLY Hanya metadata: tidak menyertakan subjek, plaintext_body, html_body.
DRAFT_VIEW_FULL Metadata + UGC (Perilaku default).

Skema Output

Pesan respons untuk ListDrafts RPC.

ListDraftsResponse

Representasi JSON 
{
  "drafts": [
    {
      object (Draft)
    }
  ],
  "nextPageToken": string
}
Kolom
drafts[]

object (Draft)

Daftar draf.
nextPageToken

string

Token yang dapat digunakan dalam panggilan berikutnya untuk mengambil halaman draf berikutnya. Jika jumlah draf yang cocok dengan kueri melebihi batas page_size, respons akan berisi next_page_token. Untuk mengambil halaman hasil berikutnya, teruskan token ini di kolom page_token dari ListDraftsRequest berikutnya.

Draf

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

string

ID unik resource draf.
subject

string

Baris subjek pesan draf.
threadId

string

ID thread yang berisi draf ini.
toRecipients[]

string

Daftar alamat email penerima 'Kepada' yang diekstrak dari header.
ccRecipients[]

string

Daftar alamat email penerima 'Cc' yang diekstrak dari header.
bccRecipients[]

string

Daftar alamat email penerima 'Bcc' yang diekstrak dari header.
plaintextBody

string

Konten isi teks biasa, jika tersedia.
date

string

Tanggal draf dalam format ISO 8601 (YYYY-MM-DD).
htmlBody

string

Konten isi HTML draf, jika tersedia.

Anotasi Alat

Petunjuk Destruktif: ❌ | Petunjuk Idempoten: ❌ | Petunjuk Hanya Baca: ✅ | Petunjuk Dunia Terbuka: ❌

Cakupan Otorisasi

Memerlukan salah satu cakupan OAuth berikut:

  • 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