MCP Tools Reference: paydeveloper.googleapis.com

टूल: list_principals

यह उन प्रिंसिपल (उपयोगकर्ताओं) की सूची बनाता है जिनके पास किसी कारोबारी या कंपनी का ऐक्सेस है. इस कार्रवाई के लिए, कारोबारी या कंपनी के पास एडमिन ऐक्सेस होना ज़रूरी है.

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

कर्ल अनुरोध 
curl --location 'https://paydeveloper.googleapis.com/mcp' \
--header 'content-type: application/json' \
--header 'accept: application/json, text/event-stream' \
--data '{
  "method": "tools/call",
  "params": {
    "name": "list_principals",
    "arguments": {
      // Provide these details according to the MCP tool specification.
    }
  },
  "jsonrpc": "2.0",
  "id": 1
}'

इनपुट स्कीमा

किसी व्यापारी के प्रिंसिपल की लिस्टिंग के लिए अनुरोध मैसेज.

ListPrincipalsRequest

JSON के काेड में दिखाना 
{
  "merchantId": string
}
फ़ील्ड
merchantId

string

ज़रूरी है. वह व्यापारी आईडी, जिसके लिए मुख्य व्यापारियों की सूची बनानी है.

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

कारोबारी या कंपनी के मुख्य लोगों की जानकारी देने वाली लिस्टिंग के लिए जवाब का मैसेज.

ListPrincipalsResponse

JSON के काेड में दिखाना 
{
  "principals": [
    {
      object (Principal)
    }
  ]
}
फ़ील्ड
principals[]

object (Principal)

ऐसे प्रिंसिपल जिनके पास कारोबारी या कंपनी का ऐक्सेस है.

मुख्य रकम

JSON के काेड में दिखाना 
{
  "email": string,
  "displayName": string,
  "role": enum (PrincipalRole),
  "state": enum (State)
}
फ़ील्ड
email

string

ज़रूरी है. प्रिंसिपल का ईमेल पता.
displayName

string

सिर्फ़ आउटपुट के लिए. प्रिंसिपल का डिसप्ले नेम.
role

enum (PrincipalRole)

कारोबारी या कंपनी के लिए मुख्य खाते की भूमिका.
state

enum (State)

सिर्फ़ आउटपुट के लिए. कारोबारी या कंपनी के खाते के लिए, मुख्य खाते की ऐक्सेस स्थिति.

PrincipalRole

यह एक ऐसी भूमिका है जो किसी कारोबारी या कंपनी के प्रिंसिपल (उपयोगकर्ता) को दी जा सकती है.

Enums
PRINCIPAL_ROLE_UNSPECIFIED भूमिका के बारे में जानकारी नहीं दी गई है.
ADMIN कारोबारी या कंपनी के लिए पूरा ऐक्सेस, जिसमें उपयोगकर्ताओं को मैनेज करना भी शामिल है.
DEVELOPER यह ऐक्सेस, कारोबारी या कंपनी के साथ इंटिग्रेट करने वाले डेवलपर के लिए है.

राज्य

किसी व्यापारी पर मुख्य व्यक्ति की पहुंच की स्थिति.

Enums
STATE_UNSPECIFIED ऐक्सेस की स्थिति के बारे में नहीं बताया गया है.
ACTIVE प्रधानाचार्य के पास सक्रिय और स्वीकृत पहुंच है.
PENDING प्रधानाचार्य को आमंत्रित किया गया है, लेकिन उन्होंने अभी तक निमंत्रण स्वीकार नहीं किया है.
EXPIRED प्रिंसिपल के न्योते की समयसीमा खत्म हो गई है.

टूल एनोटेशन

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

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

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

विनाशकारी संकेत: ❌ | निष्क्रिय संकेत: ✅ | केवल पढ़ने योग्य संकेत: ✅ | खुली दुनिया का संकेत: ❌