MCP Tools Reference: gmailmcp.googleapis.com

כלי: list_labels

רשימה של כל התוויות שהוגדרו על ידי המשתמש וזמינות בחשבון Gmail של המשתמש המאומת. אפשר להשתמש בכלי הזה כדי לגלות את id של תווית משתמש לפני שקוראים לפונקציות label_thread, unlabel_thread, label_message או unlabel_message. הכלי הזה לא מחזיר תוויות מערכת, אבל אפשר להשתמש בהן עם המזהים המוכרים שלהן: INBOX,‏ TRASH,‏ SPAM,‏ STARRED,‏ UNREAD,‏ IMPORTANT,‏ CHAT,‏ DRAFT,‏ SENT.

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

בקשת סריקה 
curl --location 'https://gmailmcp.googleapis.com/mcp/v1' \
--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
}'

סכימת הקלט

הודעת הבקשה של ListLabels RPC.

ListLabelsRequest

ייצוג ב-JSON 
{

  "pageSize": integer

  "pageToken": string
}
שדות

שדה איחוד _page_size.

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

integer

אופציונלי. המספר המקסימלי של התוויות שיוחזרו.

שדה איחוד _page_token.

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

string

אופציונלי. אסימון דף לאחזור דף ספציפי של תוצאות ברשימה.

סכימת פלט

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

ListLabelsResponse

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

object (Label)

רשימה של תוויות משתמש בחשבון של המשתמש.
nextPageToken

string

טוקן לאחזור של דף התוצאות הבא ברשימה.

תווית

ייצוג ב-JSON 
{
  "labelId": string,
  "name": string,
  "color": {
    object (LabelColor)
  },

  "threadsTotal": integer

  "threadsUnread": integer
}
שדות
labelId

string

המזהה הייחודי של התווית.
name

string

השם המוצג של התווית, בפורמט שקריא לבני אדם.
color

object (LabelColor)

אופציונלי. הצבע של התווית.

שדה איחוד _threads_total.

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

integer

המספר הכולל של השרשורים תחת התווית.

שדה איחוד _threads_unread.

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

integer

מספר השרשורים שלא נקראו תחת התווית.

LabelColor

ייצוג ב-JSON 
{
  "textColor": string,
  "backgroundColor": string
}
שדות
textColor

string

צבע הטקסט של התווית, שמיוצג כמחרוזת הקסדצימלית (למשל, ‎#000000).
backgroundColor

string

צבע הרקע של התווית, שמיוצג כמחרוזת הקסדצימלית (למשל, ‎#ffffff).

הערות על כלי

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