MCP Tools Reference: chatmcp.googleapis.com

टूल: list_memberships

इससे, Google Chat पर होने वाली बातचीत में शामिल सदस्यों की सूची दिखती है.

यहां दिए गए कोड के नमूने में, list_memberships MCP टूल को कॉल करने के लिए, curl का इस्तेमाल करने का तरीका दिखाया गया है.

Curl का अनुरोध 
curl --location 'https://chatmcp.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_memberships",
    "arguments": {
      // provide these details according to the tool MCP specification
    }
  },
  "jsonrpc": "2.0",
  "id": 1
}'

इनपुट स्कीमा

ListMembershipsRequest

JSON के काेड में दिखाना 
{
  "conversationId": string,
  "pageSize": integer,
  "pageToken": string,
  "membershipFilter": enum (MembershipFilter)
}
फ़ील्ड
conversationId

string

ज़रूरी है. यह उस बातचीत का आईडी है जिसमें शामिल सदस्यों की सूची देखनी है. फ़ॉर्मैट: spaces/{space}
pageSize

integer

ज़रूरी नहीं. यह सदस्यों की सूची में शामिल किए जाने वाले सदस्यों की ज़्यादा से ज़्यादा संख्या है. सेवा, इस वैल्यू से कम संख्या में सदस्यों की सूची दिखा सकती है. अगर कोई वैल्यू तय नहीं की गई है या कोई पॉज़िटिव वैल्यू सेट नहीं की गई है, तो डिफ़ॉल्ट वैल्यू के तौर पर 20 का इस्तेमाल किया जाता है. ज़्यादा से ज़्यादा 50 वैल्यू सेट की जा सकती है.
pageToken

string

ज़रूरी नहीं. यह पेज टोकन है, जो list_memberships को कॉल करने पर मिला था. अगला पेज पाने के लिए, इसे सबमिट करें.
membershipFilter

enum (MembershipFilter)

ज़रूरी नहीं. इससे, सदस्यों की सूची में शामिल किए जाने वाले सदस्यों का सबसेट तय होता है. अगर कोई वैल्यू तय नहीं की गई है, तो सिर्फ़ JOINED सदस्यताएं दिखाई जाती हैं.

MembershipFilter

इससे, सदस्यों की सूची में शामिल किए जाने वाले सदस्यों का सबसेट तय होता है.

Enums
MEMBERSHIP_FILTER_UNSPECIFIED डिफ़ॉल्ट मान. अगर कोई वैल्यू तय नहीं की गई है, तो सिर्फ़ JOINED सदस्यताएं दिखाई जाती हैं.
JOINED_ONLY सिर्फ़ JOINED सदस्यताएं दिखाता है.
JOINED_AND_INVITED JOINED और INVITED सदस्यताएं दिखाता है.

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

यह रिस्पॉन्स, बातचीत में शामिल सदस्यों की सूची दिखाता है.

ListMembershipsResponse

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

object (Membership)

यह अनुरोध की गई बातचीत में शामिल सदस्यों की सूची है.
nextPageToken

string

यह टोकन, page_token के तौर पर भेजा जा सकता है, ताकि अगला पेज पाया जा सके. अगर यह फ़ील्ड शामिल नहीं किया जाता है, तो इसका मतलब है कि कोई और पेज नहीं है.

सदस्यता

JSON के काेड में दिखाना 
{
  "member": {
    object (User)
  },
  "state": enum (State),
  "role": enum (Role)
}
फ़ील्ड
member

object (User)

यह वह उपयोगकर्ता है जो सदस्य है.
state

enum (State)

सिर्फ़ आउटपुट के लिए. यह सदस्यता की स्थिति है.
role

enum (Role)

यह सदस्य की भूमिका है.

उपयोगकर्ता

JSON के काेड में दिखाना 
{
  "userId": string,
  "displayName": string,
  "email": string,
  "userType": enum (UserType)
}
फ़ील्ड
userId

string

यह Chat इस्तेमाल करने वाले व्यक्ति के संसाधन का नाम है. फ़ॉर्मैट: users/{user}.
displayName

string

यह Chat इस्तेमाल करने वाले व्यक्ति का डिसप्ले नेम है.
email

string

यह उपयोगकर्ता का ईमेल पता है. यह फ़ील्ड सिर्फ़ तब पॉप्युलेट होता है, जब उपयोगकर्ता का टाइप HUMAN होता है.
userType

enum (UserType)

यह उपयोगकर्ता का टाइप है.

UserType

यह Google Chat इस्तेमाल करने वाले व्यक्ति का टाइप है.

Enums
USER_TYPE_UNSPECIFIED नहीं बताया गया है.
HUMAN यह कोई व्यक्ति है.
APP यह कोई ऐप्लिकेशन है.

राज्य

यह सदस्यता की स्थिति है.

Enums
STATE_UNSPECIFIED नहीं बताया गया है.
JOINED उपयोगकर्ता, स्पेस का सदस्य है.
INVITED उपयोगकर्ता को स्पेस में शामिल होने का न्योता मिला है.

भूमिका

यह सदस्य की भूमिका है.

Enums
ROLE_UNSPECIFIED नहीं बताया गया है.
MEMBER उपयोगकर्ता, स्पेस का सदस्य है.
MANAGER उपयोगकर्ता, स्पेस का मैनेजर है.
ASSISTANT_MANAGER उपयोगकर्ता, स्पेस का असिस्टेंट मैनेजर है.

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

टूल के एनोटेशन, MCP क्लाइंट को भेजे जाते हैं. इनसे किसी टूल के इस्तेमाल से जुड़े बुनियादी जोखिम के बारे में पता चलता है. ज़्यादातर क्लाइंट, इन संकेतों को भरोसेमंद नहीं मानते. हालांकि, इनका इस्तेमाल यह तय करने के लिए किया जा सकता है कि किसी उपयोगकर्ता को पुष्टि करने का प्रॉम्प्ट कब भेजा जाए.

टाइटल स्ट्रिंग के साथ-साथ, यहां दिए गए बूलियन हिंट इस तरह से तय किए जाते हैं:

  • readOnlyHint: अगर यह 'सही है' पर सेट है, तो इसका मतलब है कि टूल अपने एनवायरमेंट में कोई बदलाव नहीं करता. डिफ़ॉल्ट: 'गलत है'.
  • destructiveHint: अगर यह 'सही है' पर सेट है, तो इसका मतलब है कि टूल, डेटा को मिटाने वाली कार्रवाइयां कर सकता है. अगर यह 'गलत है' पर सेट है, तो इसका मतलब है कि टूल सिर्फ़ डेटा जोड़ने वाली कार्रवाइयां कर सकता है. डिफ़ॉल्ट: 'सही है'.
  • idempotentHint: अगर यह 'सही है' पर सेट है, तो इसका मतलब है कि एक ही आर्ग्युमेंट के साथ टूल को बार-बार कॉल करने पर, उसके एनवायरमेंट पर कोई अतिरिक्त असर नहीं पड़ेगा. डिफ़ॉल्ट: 'गलत है'.
  • openWorldHint: अगर यह 'सही है' पर सेट है, तो इसका मतलब है कि टूल, बाहरी इकाइयों की 'विशाल दुनिया' के साथ इंटरैक्ट कर सकता है. अगर यह 'गलत है' पर सेट है, तो इसका मतलब है कि टूल सिर्फ़ इंटरनल इकाइयों के साथ इंटरैक्ट कर सकता है. उदाहरण के लिए, वेब सर्च टूल, ओपन वर्ल्ड वाला टूल होगा. वहीं, मेमोरी टूल, ओपन वर्ल्ड वाला टूल नहीं होगा.

डेटा मिटाने वाला हिंट: ❌ | एक ही आर्ग्युमेंट के साथ बार-बार कॉल करने पर कोई अतिरिक्त असर नहीं पड़ने वाला हिंट: ✅ | सिर्फ़ डेटा देखने की अनुमति देने वाला हिंट: ✅ | ओपन वर्ल्ड वाला हिंट: ❌

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

इसके लिए, इनमें से किसी एक OAuth अनुमति की ज़रूरत होती है:

  • https://www.googleapis.com/auth/chat.memberships
  • https://www.googleapis.com/auth/chat.memberships.readonly