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)

वे मुख्य लोग जिनके पास मर्चेंट का ऐक्सेस है.

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 यह ऐक्सेस, मर्चेंट के साथ इंटिग्रेट करने वाले डेवलपर के लिए है.

State

किसी मर्चेंट के लिए मुख्य व्यक्ति के ऐक्सेस की स्थिति.

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

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

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

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

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

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