MCP Tools Reference: gmailmcp.googleapis.com

ابزار: list_labels

تمام برچسب‌های تعریف‌شده توسط کاربر موجود در حساب جیمیل کاربر احراز هویت‌شده را فهرست می‌کند. از این ابزار برای کشف id برچسب کاربر قبل از فراخوانی label_thread ، unlabel_thread ، label_message یا unlabel_message استفاده کنید. برچسب‌های سیستم توسط این ابزار بازگردانده نمی‌شوند، اما می‌توانند با شناسه‌های شناخته‌شده‌شان مورد استفاده قرار گیرند: 'INBOX'، 'TRASH'، 'SPAM'، 'STARRED'، 'UNREAD'، 'IMPORTANT'، 'CHAT'، 'DRAFT'، 'SENT'.

نمونه زیر نحوه استفاده از curl برای فراخوانی ابزار list_labels MCP را نشان می‌دهد.

درخواست کرل
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
}'
                

طرحواره ورودی

درخواست پیام برای RPC مربوط به ListLabels.

درخواست برچسب‌های لیست

نمایش JSON
{

  "pageSize": integer

  "pageToken": string
}
فیلدها

فیلد یونیون _page_size .

_page_size می‌تواند فقط یکی از موارد زیر باشد:

pageSize

integer

اختیاری. حداکثر تعداد برچسب‌هایی که باید برگردانده شوند.

فیلد یونیون _page_token .

_page_token فقط می‌تواند یکی از موارد زیر باشد:

pageToken

string

اختیاری. توکن صفحه برای بازیابی یک صفحه خاص از نتایج در لیست.

طرحواره خروجی

پیام پاسخ برای RPC لیست‌لیبل‌ها.

پاسخ ListLabels

نمایش 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

تعداد رشته‌های خوانده نشده زیر برچسب.

رنگ برچسب

نمایش 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 e4d7f5، #fcdee8 ، #efa093 ، #ffd6a2 ، #fce8b3 ، #89d3b2 ، #a0eac9 , #a4c2f4 , #d0bcf1 , #fbc8d9 , #e66550 , #ffbc6b , #fcda83 , #44b984 , #68dfa9 , #b694e8 #6d9eeb , #f7a7c0 , #cc3a21 #eaa041 ، #f2c960 ، #149e60 ، #3dc789 ، # #3c78d8 ، #e07798 #8e63ce ، #ac2b16 e07798، #cf8933 ، #d5ae49 ، #0b804b ، #2a9c68 #285bac ، #653e9b ، #b65775 ، #822111 ، #a46a21 ، #aa8831 ، #076239 ، #1c4587 #1a764d #41236d ، #83334c ، #464646 ، #e7e7e7 #0d3472 #b6cff5 ، #0d3b44 #98d7e4 ، #3d188e ، #e3d7ff ، #711a36 ، #fbd3e0 ، #f2b2a8 #8a1c0a ، #7a2e0b ، #7a4706 #ffc8af ، # #594c05 #ffdeb5 ، # #fbe983 #684e07 ، #fdedc1 ، #0b4f30 ، #b3efd3 ، #04502e ، #a2dcc1 ، #c2c2c2 ، #4986e7 ، # #2da2bb ، #994a64 #b99aff ، #f691b2 ، #ff7537 ، #ffad46 ، 3، #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 e4d7f5، #fcdee8 ، #efa093 ، #ffd6a2 ، #fce8b3 ، #89d3b2 ، #a0eac9 , #a4c2f4 , #d0bcf1 , #fbc8d9 , #e66550 , #ffbc6b , #fcda83 , #44b984 , #68dfa9 , #b694e8 #6d9eeb , #f7a7c0 , #cc3a21 #eaa041 ، #f2c960 ، #149e60 ، #3dc789 ، # #3c78d8 ، #e07798 #8e63ce ، #ac2b16 e07798، #cf8933 ، #d5ae49 ، #0b804b ، #2a9c68 #285bac ، #653e9b ، #b65775 ، #822111 ، #a46a21 ، #aa8831 ، #076239 ، #1c4587 #1a764d #41236d ، #83334c ، #464646 ، #e7e7e7 #0d3472 #b6cff5 ، #0d3b44 #98d7e4 ، #3d188e ، #e3d7ff ، #711a36 ، #fbd3e0 ، #f2b2a8 #8a1c0a ، #7a2e0b ، #7a4706 #ffc8af ، # #594c05 #ffdeb5 ، # #fbe983 #684e07 ، #fdedc1 ، #0b4f30 ، #b3efd3 ، #04502e ، #a2dcc1 ، #c2c2c2 ، #4986e7 ، #b99aff #2da2bb ، #994a64 b99aff، #f691b2 ، #ff7537 ، #ffad46 ، 3، #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