ابزار: list_memberships
عضویتها را در مکالمه Google Chat فهرست میکند.
نمونه کد زیر نحوه استفاده از curl برای فراخوانی ابزار MCP list_memberships را نشان میدهد.
| درخواست 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 MCP tool specification. } }, "jsonrpc": "2.0", "id": 1 }' |
طرحواره ورودی
ListMembershipsRequest
| نمایش JSON |
|---|
{
"conversationId": string,
"pageSize": integer,
"pageToken": string,
"membershipFilter": enum ( |
| فیلدها | |
|---|---|
conversationId |
الزامی. شناسه مکالمهای که میخواهید عضویتهای آن فهرست شود. قالب: spaces/{space} |
pageSize |
اختیاری. حداکثر تعداد عضویتها برای برگرداندن. سرویس ممکن است کمتر از این مقدار را برگرداند. اگر نامشخص باشد یا روی مقدار غیرمثبت تنظیم شده باشد، از مقدار پیشفرض ۲۰ استفاده میشود. حداکثر مقدار مجاز ۵۰ است. |
pageToken |
اختیاری. یک توکن صفحه، که از تماس list_memberships قبلی دریافت شده است. برای بازیابی صفحه بعدی، این را ارائه دهید. |
membershipFilter |
اختیاری. زیرمجموعه عضویتها را برای برگرداندن مشخص میکند. اگر مشخص نشده باشد، فقط عضویتهای «پیوسته» برگردانده میشود. |
MembershipFilter
زیرمجموعه عضویتها را برای برگرداندن مشخص میکند.
| شمارشیها | |
|---|---|
MEMBERSHIP_FILTER_UNSPECIFIED |
مقدار پیشفرض. اگر مشخص نشده باشد، فقط عضویتهای «پیوسته» را برمیگرداند. |
JOINED_ONLY |
فقط عضویتهای «پیوسته» را برمیگرداند. |
JOINED_AND_INVITED |
عضویتهای «پیوسته» و «دعوتشده» را برمیگرداند. |
طرحواره برونداد
پاسخ حاوی فهرست عضویتها در مکالمه.
ListMembershipsResponse
| نمایش JSON |
|---|
{
"memberships": [
{
object ( |
| فیلدها | |
|---|---|
memberships[] |
فهرست عضویتها در مکالمه درخواستشده. |
nextPageToken |
نشانهای که میتواند بهعنوان |
عضویت
| نمایش JSON |
|---|
{ "member": { object ( |
| فیلدها | |
|---|---|
member |
کاربری که عضو است. |
state |
فقط خروجی. وضعیت عضویت. |
role |
نقش عضو. |
کاربر
| نمایش JSON |
|---|
{
"userId": string,
"displayName": string,
"email": string,
"userType": enum ( |
| فیلدها | |
|---|---|
userId |
نام منبع کاربر Chat. قالب: users/{user}. |
displayName |
نام نمایشی کاربر Chat. |
email |
نشانی ایمیل کاربر. این فیلد فقط زمانی پر میشود که نوع کاربر HUMAN (انسان) باشد. |
userType |
نوع کاربر. |
UserType
نوع کاربر Google Chat.
| شمارشیها | |
|---|---|
USER_TYPE_UNSPECIFIED |
نامشخص. |
HUMAN |
کاربر انسانی. |
APP |
کاربر برنامه. |
ایالت
وضعیت عضویت.
| شمارشیها | |
|---|---|
STATE_UNSPECIFIED |
نامشخص. |
JOINED |
کاربر عضو فضا است. |
INVITED |
کاربر برای پیوستن به فضا دعوت میشود. |
نقش
نقش عضو.
| شمارشیها | |
|---|---|
ROLE_UNSPECIFIED |
نامشخص. |
MEMBER |
کاربر عضو فضا است. |
MANAGER |
کاربر مدیر فضا باشد. |
ASSISTANT_MANAGER |
کاربر دستیار مدیر فضا است. |
حاشیهنویسیهای ابزار
حاشیهنویسیهای ابزار به کارخواهان MCP ارسال میشود تا خطر اصلی ابزار موردنظر را شرح دهد. اکثر کارخواهها این راهنماییها را غیرقابلاعتماد تلقی میکنند، اما میتوان از آنها برای تصمیمگیری درباره زمان ارسال پیامواره تأیید به کاربر استفاده کرد.
همراه با رشته عنوان، نکات بولی زیر بهصورت زیر تعریف میشوند:
-
readOnlyHint: اگر درست باشد، ابزار محیط خود را تغییر نمیدهد. پیشفرض: false. -
destructiveHint: اگر درست باشد، ابزار میتواند کنشهای مخرب انجام دهد. اگر نادرست باشد، ابزار فقط میتواند کنشهای افزایشی انجام دهد. پیشفرض: true. idempotentHint: اگر درست باشد، فراخوانی مکرر ابزار با آرگومانهای یکسان تأثیر بیشتری بر محیط آن نخواهد داشت. پیشفرض: false.openWorldHint: اگر درست باشد، ابزار میتواند با «دنیای باز» نهادهای خارجی تعامل داشته باشد. اگر نادرست باشد، ابزار فقط میتواند با نهادهای داخلی تعامل داشته باشد. برای مثال، ابزار جستجوی وب دنیای باز است، درحالیکه ابزار حافظه دنیای باز نیست.
Destructive Hint: ❌ | Idempotent Hint: ✅ | Read Only Hint: ✅ | Open World Hint: ❌
دامنههای مجوز
به یکی از دامنههای OAuth زیر نیاز دارد:
https://www.googleapis.com/auth/chat.membershipshttps://www.googleapis.com/auth/chat.memberships.readonly