MCP Tools Reference: chatmcp.googleapis.com

ابزار: list_memberships

عضویت‌ها را در یک مکالمه Google Chat فهرست می‌کند.

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

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

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

درخواست عضویت‌ها

نمایش JSON 
{
  "conversationId": string,
  "pageSize": integer,
  "pageToken": string,
  "membershipFilter": enum (MembershipFilter)
}
فیلدها
conversationId

string

الزامی. شناسه مکالمه‌ای که قرار است اعضا در آن فهرست شوند. قالب: فاصله/{فاصله}

pageSize

integer

اختیاری. حداکثر تعداد عضویت‌هایی که باید برگردانده شود. سرویس ممکن است کمتر از این مقدار را برگرداند. اگر مشخص نشود یا روی یک مقدار غیرمثبت تنظیم شود، مقدار پیش‌فرض ۲۰ استفاده می‌شود. حداکثر مقدار مجاز ۵۰ است.

pageToken

string

اختیاری. یک توکن صفحه، که از فراخوانی قبلی list_memberships دریافت شده است. این توکن را برای بازیابی صفحه بعدی ارائه دهید.

membershipFilter

enum ( MembershipFilter )

اختیاری. زیرمجموعه‌ای از عضویت‌ها را برای بازگرداندن مشخص می‌کند. اگر مشخص نشود، فقط عضویت‌های JOINED بازگردانده می‌شوند.

فیلتر عضویت

زیرمجموعه‌ای از عضویت‌ها را که باید برگردانده شود، مشخص می‌کند.

انوم‌ها
MEMBERSHIP_FILTER_UNSPECIFIED مقدار پیش‌فرض. اگر مشخص نشود، فقط عضویت‌های ثبت‌شده را برمی‌گرداند.
JOINED_ONLY فقط عضویت‌های JOINED را برمی‌گرداند.
JOINED_AND_INVITED عضویت‌های JOINED و INVITED را برمی‌گرداند.

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

پاسخی حاوی فهرست اعضای حاضر در مکالمه.

فهرست عضویت‌هاپاسخ

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

نام منبع یک کاربر چت. فرمت: users/{user}.

displayName

string

نام نمایشی کاربر چت.

email

string

آدرس ایمیل کاربر. این فیلد فقط زمانی پر می‌شود که نوع کاربر HUMAN باشد.

userType

enum ( UserType )

نوع کاربر.

نوع کاربر

نوع کاربر گوگل چت.

انوم‌ها
USER_TYPE_UNSPECIFIED نامشخص.
HUMAN کاربر انسانی.
APP کاربر برنامه.

ایالت

وضعیت عضویت.

انوم‌ها
STATE_UNSPECIFIED نامشخص.
JOINED کاربر عضوی از فضا است.
INVITED از کاربر دعوت می‌شود تا به این فضا بپیوندد.

نقش

نقش عضو.

انوم‌ها
ROLE_UNSPECIFIED نامشخص.
MEMBER کاربر عضوی از فضا است.
MANAGER کاربر، مدیر فضا است.
ASSISTANT_MANAGER کاربر دستیار مدیر فضا است.

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

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

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

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

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

دامنه‌های مجوز

به یکی از حوزه‌های OAuth زیر نیاز دارد:

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