MCP Tools Reference: paydeveloper.googleapis.com

ابزار: list_principals

فهرستی از کاربران اصلی (Principals) که به یک فروشنده خاص دسترسی دارند. این عملیات نیاز به دسترسی ادمین برای فروشنده دارد.

نمونه کد زیر نحوه استفاده از curl برای فراخوانی ابزار list_principals MCP را نشان می‌دهد.

درخواست کرل 
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
}'

طرحواره ورودی

درخواست پیام برای فهرست کردن مدیران یک تاجر.

درخواست لیست مدیران

نمایش JSON 
{
  "merchantId": string
}
فیلدها
merchantId

string

الزامی. شناسه فروشنده، که برای فهرست کردن مدیران اصلی استفاده می‌شود.

طرحواره خروجی

پیام پاسخ برای فهرست کردن مدیران یک تاجر.

پاسخ فهرست مدیران

نمایش 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 )

فقط خروجی. وضعیت دسترسی مدیر اصلی به تاجر.

نقش اصلی

نقشی که می‌تواند به یک مدیر (کاربر) در یک تاجر اعطا شود.

انوم‌ها
PRINCIPAL_ROLE_UNSPECIFIED نقش نامشخص است.
ADMIN دسترسی کامل به فروشنده، از جمله مدیریت کاربران.
DEVELOPER دسترسی در نظر گرفته شده برای توسعه‌دهندگانی که با فروشنده ادغام می‌شوند.

ایالت

وضعیت دسترسی یک مدیر به یک تاجر.

انوم‌ها
STATE_UNSPECIFIED وضعیت دسترسی مشخص نیست.
ACTIVE مدیر دسترسی فعال و پذیرفته‌شده‌ای دارد.
PENDING از مدیر مدرسه دعوت شده اما هنوز دعوت را نپذیرفته است.
EXPIRED دعوتنامه مدیر منقضی شده است.

حاشیه‌نویسی ابزار

حاشیه‌نویسی‌های ابزار برای توصیف ریسک اولیه‌ی یک ابزار مشخص به کلاینت‌های MCP ارسال می‌شوند. اکثر کلاینت‌ها این نکات را غیرقابل اعتماد می‌دانند، اما می‌توان از آنها برای تصمیم‌گیری در مورد زمان ارسال پیام تأیید به کاربر استفاده کرد.

همراه با رشته عنوان، نکات بولی زیر به صورت زیر تعریف می‌شوند:

  • readOnlyHint : اگر درست باشد، ابزار محیط خود را تغییر نمی‌دهد. پیش‌فرض: نادرست.
  • destructiveHint : اگر درست باشد، ابزار می‌تواند اقدامات مخرب انجام دهد. اگر نادرست باشد، ابزار فقط می‌تواند اقدامات افزایشی انجام دهد. پیش‌فرض: درست.
  • idempotentHint : اگر مقدار آن درست باشد، فراخوانی مکرر ابزار با آرگومان‌های یکسان، هیچ تأثیر اضافی بر محیط آن نخواهد داشت. پیش‌فرض: false.
  • openWorldHint : اگر درست باشد، ابزار می‌تواند با «دنیای باز» از موجودیت‌های خارجی تعامل داشته باشد. اگر نادرست باشد، ابزار فقط می‌تواند با موجودیت‌های داخلی تعامل داشته باشد. برای مثال، یک ابزار جستجوی وب جهان‌باز خواهد بود، در حالی که یک ابزار حافظه جهان‌باز نخواهد بود.

راهنمایی مخرب: ❌ | راهنمایی بی‌اثر: ✅ | راهنمایی فقط خواندنی: ✅ | راهنمایی جهان باز: ❌