MCP Tools Reference: gmailmcp.googleapis.com

כלי: list_drafts

הפונקציה מחזירה רשימה של טיוטות אימייל מחשבון Gmail של המשתמש המאומת.

הכלי הזה יכול לסנן טיוטות על סמך מחרוזת שאילתה, והוא תומך בחלוקה לעמודים. הפונקציה מחזירה רשימה של טיוטות, כולל המזהים והנושאים שלהן (אלא אם view מוגדר כ-DRAFT_VIEW_METADATA_ONLY). אפשר להשתמש ב-page_token כדי להציג את התוצאות בדפים. כדי לאחזר דפים נוספים של תוצאות, משתמשים בpage_token שהוחזר בתשובה הקודמת.

הפרמטר view קובע אילו שדות יאוכלסו בתשובה. כברירת מחדל (או עם DRAFT_VIEW_FULL), הפונקציה מחזירה תוכן מלא. אפשר להשתמש בDRAFT_VIEW_METADATA_ONLY כדי להחריג תוכן רגיש כמו הנושא והגוף.

בדוגמה הבאה אפשר לראות איך משתמשים ב-curl כדי להפעיל את כלי ה-MCP‏ list_drafts.

בקשת 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
}'

סכימת הקלט

הודעת בקשה לקריאה לשירות מרוחק (RPC) של ListDrafts.

ListDraftsRequest

ייצוג ב-JSON 
{

  "pageSize": integer

  "pageToken": string

  "query": string

  "view": enum (DraftView)
}
שדות

שדה איחוד _page_size.

הערך _page_size יכול להיות רק אחד מהבאים:
pageSize

integer

אופציונלי. מספר הטיוטות המקסימלי שיוחזרו. אם לא מציינים ערך, ברירת המחדל היא 20. הערך המקסימלי המותר הוא 50.

שדה איחוד _page_token.

הערך _page_token יכול להיות רק אחד מהבאים:
pageToken

string

אופציונלי. טוקן שהתקבל מקריאה קודמת של list_drafts כדי לאחזר את הדף הבא של התוצאות. אם משאירים את השדה ריק, המערכת מאחזרת את הדף הראשון. הפרמטר הזה משמש בעיקר להחלפת דפים, כדי להמשיך לאחזר תוצאות מהמקום שבו הסתיימה הקריאה הקודמת של ListDraft, במיוחד כשמספר הטיוטות שתואמות לשאילתה חורג מהמגבלה של page_size.

שדה איחוד _query.

הערך _query יכול להיות רק אחד מהבאים:
query

string

דוגמאות:

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

תו רווח או קו מפריד (-) מפרידים את המספר, ואילו נקודה (.) תהיה נקודה עשרונית. לדוגמה, הביטוי 01.2047-100 נחשב כשני מספרים: 01.2047 ו-100.

הערה: כדי לוודא שכל הטיוטות של השאילתה יוחזרו, אפשר להשתמש בעימוד של התוצאות. לשם כך, צריך לבצע קריאות חוזרות לכלי עד שהתשובה תכיל רשימה ריקה של טיוטות.

שדה איחוד _view.

הערך _view יכול להיות רק אחד מהבאים:
view

enum (DraftView)

אופציונלי. הגדרת השדות שיופיעו בטיוטות ברשימת הטיוטות. כברירת מחדל (או עם DRAFT_VIEW_FULL), הפונקציה מחזירה את התוכן המלא, שכולל את מזהה הטיוטה, מזהה השרשור, הנמען, העותק, העותק המוסתר, התאריך, הנושא והגוף. כדי להחריג את הנושא והגוף, משתמשים בדגל DRAFT_VIEW_METADATA_ONLY.

DraftView

סוג Enum לשליטה בשדות שאוכלסו בטיוטות בתשובה של ListDrafts.

טיפוסים בני מנייה (enum)
DRAFT_VIEW_UNSPECIFIED מיפוי ל-DRAFT_VIEW_FULL לצורך תאימות לאחור.
DRAFT_VIEW_METADATA_ONLY מטא-נתונים בלבד: לא כולל את הנושא, plaintext_body, html_body.
DRAFT_VIEW_FULL מטא-נתונים + תוכן שנוצר על ידי משתמשים (התנהגות ברירת מחדל).

סכימת הפלט

הודעת התגובה לקריאה לשירות מרוחק (RPC) של ListDrafts.

ListDraftsResponse

ייצוג ב-JSON 
{
  "drafts": [
    {
      object (Draft)
    }
  ],
  "nextPageToken": string
}
שדות
drafts[]

object (Draft)

רשימת הטיוטות.
nextPageToken

string

טוקן שאפשר להשתמש בו בקריאה הבאה כדי לאחזר את הדף הבא של הטיוטות. אם מספר הטיוטות שתואמות לשאילתה חורג מהמגבלה של page_size, התשובה תכיל next_page_token. כדי לאחזר את הדף הבא של התוצאות, מעבירים את האסימון הזה בשדה page_token של הבקשה הבאה ListDraftsRequest.

טיוטה

ייצוג ב-JSON 
{
  "id": string,
  "subject": string,
  "threadId": string,
  "toRecipients": [
    string
  ],
  "ccRecipients": [
    string
  ],
  "bccRecipients": [
    string
  ],
  "plaintextBody": string,
  "date": string,
  "htmlBody": string
}
שדות
id

string

המזהה הייחודי של משאב הטיוטה.
subject

string

שורת הנושא של הטיוטה.
threadId

string

המזהה של השרשור שהטיוטה שייכת אליו.
toRecipients[]

string

רשימה של כתובות אימייל של נמענים בשדה 'אל' שחולצו מהכותרות.
ccRecipients[]

string

רשימה של כתובות אימייל של נמענים בשדה 'עותק' שחולצו מהכותרות.
bccRecipients[]

string

רשימה של כתובות אימייל של נמענים בשדה 'עותק מוסתר' שחולצו מהכותרות.
plaintextBody

string

תוכן הגוף בטקסט פשוט, אם זמין.
date

string

תאריך הטיוטה בפורמט ISO 8601‏ (YYYY-MM-DD).
htmlBody

string

תוכן ה-HTML של גוף הטיוטה, אם זמין.

הערות על כלים

רמז הרסני: ❌ | רמז אידמפוטנטי: ❌ | רמז לקריאה בלבד: ✅ | רמז לעולם פתוח: ❌

היקפי הרשאות

נדרש אחד מהיקפי ההרשאות הבאים של 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