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 का इस्तेमाल करें.

यहां दिए गए उदाहरण में, list_drafts MCP टूल को शुरू करने के लिए, curl का इस्तेमाल करने का तरीका बताया गया है.

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
}'
                

इनपुट स्कीमा

ListDrafts RPC के लिए अनुरोध मैसेज.

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 के साथ), यह पूरा कॉन्टेंट दिखाता है. इसमें ड्राफ़्ट आईडी, threadID, पाने वाला, कॉपी, गुप्त कॉपी, तारीख, विषय, और मुख्य हिस्सा शामिल होता है. विषय और मुख्य हिस्से को बाहर रखने के लिए, DRAFT_VIEW_METADATA_ONLY का इस्तेमाल करें.

DraftView

यह enum, ListDrafts के जवाब में ड्राफ़्ट के लिए दिखाए जाने वाले फ़ील्ड को कंट्रोल करता है.

Enums
DRAFT_VIEW_UNSPECIFIED पिछले वर्शन के साथ काम करने की सुविधा के लिए, इसे DRAFT_VIEW_FULL पर मैप किया जाता है.
DRAFT_VIEW_METADATA_ONLY सिर्फ़ मेटाडेटा: इसमें विषय, plaintext_body, html_body शामिल नहीं होता.
DRAFT_VIEW_FULL मेटाडेटा + यूज़र जनरेटेड कॉन्टेंट (डिफ़ॉल्ट व्यवहार).

आउटपुट स्कीमा

ListDrafts RPC के लिए जवाब मैसेज.

ListDraftsResponse

JSON के काेड में दिखाना
{
  "drafts": [
    {
      object (Draft)
    }
  ],
  "nextPageToken": string
}
फ़ील्ड
drafts[]

object (Draft)

ड्राफ़्ट की सूची.

nextPageToken

string

यह एक टोकन है. इसका इस्तेमाल, ड्राफ़्ट का अगला पेज पाने के लिए, बाद में किए जाने वाले कॉल में किया जा सकता है. अगर क्वेरी से मेल खाने वाले ड्राफ़्ट की संख्या, page_size की सीमा से ज़्यादा है, तो जवाब में next_page_token शामिल होगा. नतीजों का अगला पेज पाने के लिए, इस टोकन को ListDraftsRequest के अगले page_token फ़ील्ड में पास करें.

Draft

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

आईएसओ 8601 फ़ॉर्मैट (YYYY-MM-DD) में ड्राफ़्ट की तारीख.

htmlBody

string

अगर उपलब्ध हो, तो ड्राफ़्ट के मुख्य हिस्से का एचटीएमएल कॉन्टेंट.

टूल के एनोटेशन

डिस्ट्रक्टिव हिंट: ❌ | आइडमपोटेंट हिंट: ❌ | सिर्फ़ पढ़ने की अनुमति वाली हिंट: ✅ | ओपन वर्ल्ड हिंट: ❌

अनुमति पाने के लिंक

इसके लिए, इनमें से किसी एक 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