الأداة: list_labels
تعرض هذه الطريقة جميع التصنيفات التي يحدّدها المستخدم والمتاحة في حساب Gmail الخاص بالمستخدم الذي تمّت مصادقته. استخدِم هذه الأداة لاكتشاف id لتصنيف مستخدم قبل طلب label_thread أو unlabel_thread أو label_message أو unlabel_message. لا تعرض هذه الأداة تصنيفات النظام، ولكن يمكن استخدامها مع معرّفاتها المعروفة: INBOX وTRASH وSPAM وSTARRED وUNREAD وIMPORTANT وCHAT وDRAFT وSENT.
يوضّح المثال التالي كيفية استخدام curl لاستدعاء أداة list_labels MCP.
| طلب 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 } |
| الحقول | |
|---|---|
حقل الربط يمكن أن يكون التعليق |
|
pageSize |
اختياريّ. الحدّ الأقصى لعدد التصنيفات المطلوب عرضها. |
حقل الربط يمكن أن يكون التعليق |
|
pageToken |
اختياريّ. رمز مميّز للصفحة لاسترداد صفحة معيّنة من النتائج في القائمة. |
مخطط النتائج
رسالة الردّ على استدعاء إجراء عن بُعد (RPC) الخاص بـ ListLabels.
ListLabelsResponse
| تمثيل JSON |
|---|
{
"labels": [
{
object ( |
| الحقول | |
|---|---|
labels[] |
قائمة بتصنيفات المستخدم في حسابه |
nextPageToken |
رمز مميز لاسترداد الصفحة التالية من النتائج في القائمة |
التصنيف
| تمثيل JSON |
|---|
{
"labelId": string,
"name": string,
"color": {
object ( |
| الحقول | |
|---|---|
labelId |
المعرّف الفريد للتصنيف. |
name |
الاسم المعروض للتصنيف والذي يمكن لشخص عادي قراءته. |
color |
اختياريّ. لون التصنيف |
حقل الربط يمكن أن يكون التعليق |
|
threadsTotal |
تمثّل هذه السمة إجمالي عدد سلاسل المحادثات ضمن التصنيف. |
حقل الربط يمكن أن يكون التعليق |
|
threadsUnread |
عدد سلاسل المحادثات غير المقروءة ضمن التصنيف |
LabelColor
| تمثيل JSON |
|---|
{ "textColor": string, "backgroundColor": string } |
| الحقول | |
|---|---|
textColor |
لون نص التصنيف، ويتم تمثيله كسلسلة سداسية عشرية (مثل "#000000"). يُسمح فقط بالمجموعة المحدّدة مسبقًا من قيم الألوان التالية: |
backgroundColor |
لون خلفية التصنيف، ويتم تمثيله كسلسلة سداسية عشرية (مثل "#ffffff"). يُسمح فقط بالمجموعة المحدّدة مسبقًا من قيم الألوان التالية: |
التعليقات التوضيحية للأدوات
Destructive Hint: ❌ | Idempotent Hint: ✅ | Read Only Hint: ✅ | Open World Hint: ❌
نطاقات التفويض
يجب توفير أحد نطاقات OAuth التالية:
https://mail.google.com/https://www.googleapis.com/auth/gmail.modifyhttps://www.googleapis.com/auth/gmail.readonlyhttps://www.googleapis.com/auth/gmail.labelshttps://www.googleapis.com/auth/gmail.metadata