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 
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_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). מותר להשתמש רק בערכים הבאים של צבעים שמוגדרים מראש: #000000, ‏ #434343, ‏ #666666, ‏ #999999, ‏ #cccccc, ‏ #efefef, ‏ #f3f3f3, ‏ #ffffff, ‏ #fb4c2f, ‏ #ffad47, ‏ #fad165, ‏ #16a766, ‏ #43d692, ‏ #4a86e8, ‏ #a479e2, ‏ #f691b3, ‏ #f6c5be, ‏ #ffe6c7, ‏ #fef1d1, ‏ #b9e4d0, ‏ #c6f3de, ‏ #c9daf8, ‏ #e4d7f5, ‏ #fcdee8, ‏ #efa093, ‏ #ffd6a2, ‏ #fce8b3, ‏ #89d3b2, ‏ #a0eac9, ‏ #a4c2f4, ‏ #d0bcf1, ‏ #fbc8d9, ‏ #e66550, ‏ #ffbc6b, ‏ #fcda83, ‏ #44b984, ‏ #68dfa9, ‏ #6d9eeb, ‏ #b694e8, ‏ #f7a7c0, ‏ #cc3a21, ‏ #eaa041, ‏ #f2c960, ‏ #149e60, ‏ #3dc789, ‏ #3c78d8, ‏ #8e63ce, ‏ #e07798, ‏ #ac2b16, ‏ #cf8933, ‏ #d5ae49, ‏ #0b804b, ‏ #2a9c68, ‏ #285bac, ‏ #653e9b, ‏ #b65775, ‏ #822111, ‏ #a46a21, ‏ #aa8831, ‏ #076239, ‏ #1a764d, ‏ #1c4587, ‏ #41236d, ‏ #83334c, ‏ #464646, ‏ #e7e7e7, ‏ #0d3472, ‏ #b6cff5, ‏ #0d3b44, ‏ #98d7e4, ‏ #3d188e, ‏ #e3d7ff, ‏ #711a36, ‏ #fbd3e0, ‏ #8a1c0a, ‏ #f2b2a8, ‏ #7a2e0b, ‏ #ffc8af, ‏ #7a4706, ‏ #ffdeb5, ‏ #594c05, ‏ #fbe983, ‏ #684e07, ‏ #fdedc1, ‏ #0b4f30, ‏ #b3efd3, ‏ #04502e, ‏ #a2dcc1, ‏ #c2c2c2, ‏ #4986e7, ‏ #2da2bb, ‏ #b99aff, ‏ #994a64, ‏ #f691b2, ‏ #ff7537, ‏ #ffad46, ‏ #662e37, ‏ #ebdbde, ‏ #cca6ac, ‏ #094228, ‏ #42d692, ‏ #16a765
backgroundColor

string

צבע הרקע של התווית, שמיוצג כמחרוזת הקסדצימלית (למשל, ‎#ffffff). מותר להשתמש רק בערכים הבאים של צבעים שהוגדרו מראש: #000000, #434343, #666666, #999999, #cccccc, #efefef, #f3f3f3, #ffffff, #fb4c2f, #ffad47, #fad165, #16a766, #43d692, #4a86e8, #a479e2, #f691b3, #f6c5be, #ffe6c7, #fef1d1, #b9e4d0, #c6f3de, #c9daf8, #e4d7f5, #fcdee8, #efa093, #ffd6a2, #fce8b3, #89d3b2, #a0eac9, #a4c2f4, #d0bcf1, #fbc8d9, #e66550, #ffbc6b, #fcda83, #44b984, #68dfa9, #6d9eeb, #b694e8, #f7a7c0, #cc3a21, #eaa041, #f2c960, #149e60, #3dc789, #3c78d8, #8e63ce, #e07798, #ac2b16, #cf8933, #d5ae49, #0b804b, #2a9c68, #285bac, #653e9b, #b65775, #822111, #a46a21, #aa8831, #076239, #1a764d, #1c4587, #41236d, #83334c, #464646, #e7e7e7, #0d3472, #b6cff5, #0d3b44, #98d7e4, #3d188e, #e3d7ff, #711a36, #fbd3e0, #8a1c0a, #f2b2a8, #7a2e0b, #ffc8af, #7a4706, #ffdeb5, #594c05, #fbe983, #684e07, #fdedc1, #0b4f30, #b3efd3, #04502e, #a2dcc1, #c2c2c2, #4986e7, #2da2bb, #b99aff, #994a64, #f691b2, #ff7537, #ffad46, #662e37, #ebdbde, #cca6ac, #094228, #42d692, #16a765

הערות על כלים

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

היקפי הרשאות

נדרש אחד מהיקפי ההרשאות הבאים של OAuth:

  • https://mail.google.com/
  • https://www.googleapis.com/auth/gmail.modify
  • https://www.googleapis.com/auth/gmail.readonly
  • https://www.googleapis.com/auth/gmail.labels
  • https://www.googleapis.com/auth/gmail.metadata