MCP Tools Reference: chatmcp.googleapis.com

כלי: list_memberships

רשימת המשתתפים בשיחה ב-Google Chat.

בדוגמת הקוד הבאה מוצג שימוש בפקודה curl כדי להפעיל את הכלי list_memberships MCP.

בקשת 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 tool MCP specification
    }
  },
  "jsonrpc": "2.0",
  "id": 1
}'

סכימת הקלט

ListMembershipsRequest

ייצוג JSON 
{
  "conversationId": string,
  "pageSize": integer,
  "pageToken": string,
  "membershipFilter": enum (MembershipFilter)
}
שדות
conversationId

string

חובה. המזהה של השיחה שרוצים להציג את החברים בה. פורמט: spaces/{space}
pageSize

integer

אופציונלי. מספר החברויות המקסימלי שיוחזרו. יכול להיות שהשירות יחזיר פחות מהערך הזה. אם הערך לא מצוין או מוגדר כערך לא חיובי, נעשה שימוש בערך ברירת המחדל 20. הערך המקסימלי המותר הוא 50.
pageToken

string

אופציונלי. טוקן של דף שהתקבל מקריאה קודמת של list_memberships. צריך להזין את הטוקן כדי לאחזר את הדף הבא.
membershipFilter

enum (MembershipFilter)

אופציונלי. מציין את קבוצת המשנה של החברויות במועדון שיוחזרו. אם לא מציינים ערך, מוחזרים רק חברים שהצטרפו למועדון.

MembershipFilter

מציין את קבוצת המשנה של החברויות במועדון שיוחזרו.

טיפוסים בני מנייה (enum)
MEMBERSHIP_FILTER_UNSPECIFIED ערך ברירת המחדל. אם לא מציינים ערך, המערכת מחזירה רק חברויות פעילות.
JOINED_ONLY הפונקציה מחזירה רק חברויות שהצטרפתם אליהן.
JOINED_AND_INVITED מחזירה את המינויים עם הסטטוסים JOINED ו-INVITED.

סכימת הפלט

התשובה תכיל את רשימת החברים בשיחה.

ListMembershipsResponse

ייצוג 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

שם המשאב של משתמש ב-Chat. הפורמט: users/{user}.
displayName

string

השם המוצג של המשתמש ב-Chat.
email

string

כתובת האימייל של המשתמש. השדה הזה מאוכלס רק כשסוג המשתמש הוא HUMAN.
userType

enum (UserType)

סוג המשתמש.

UserType

הסוג של משתמש Google Chat.

טיפוסים בני מנייה (enum)
USER_TYPE_UNSPECIFIED לא צוין.
HUMAN משתמש אנושי.
APP משתמש באפליקציה.

מדינה (State)

מצב המינוי.

טיפוסים בני מנייה (enum)
STATE_UNSPECIFIED לא צוין.
JOINED המשתמש חבר במרחב.
INVITED המשתמש מוזמן להצטרף למרחב.

תפקיד

התפקיד של החבר בקבוצה.

טיפוסים בני מנייה (enum)
ROLE_UNSPECIFIED לא צוין.
MEMBER המשתמש חבר במרחב.
MANAGER המשתמש הוא מנהל המרחב.
ASSISTANT_MANAGER המשתמש הוא עוזר מנהל במרחב.

הערות על כלים

הערות על כלים נשלחות ללקוחות MCP כדי לתאר את הסיכון הבסיסי של כלי מסוים. רוב הלקוחות מתייחסים לרמזים האלה כאל רמזים לא מהימנים, אבל אפשר להשתמש בהם כדי להחליט מתי לשלוח למשתמש בקשת אישור.

בנוסף למחרוזת הכותרת, מוגדרים הרמזים הבוליאניים הבאים:

  • ‫readOnlyHint: אם הערך הוא true, הכלי לא משנה את הסביבה שלו. ברירת מחדל: false.
  • ‫destructiveHint: אם הערך הוא True, הכלי יכול לבצע פעולות הרסניות. אם הערך הוא false, הכלי יכול לבצע רק פעולות של הוספה. ברירת מחדל: true.
  • ‫idempotentHint: אם הערך הוא True, קריאה חוזרת לכלי עם אותם ארגומנטים לא תשפיע על הסביבה שלו. ברירת מחדל: false.
  • ‫openWorldHint: אם הערך הוא True, הכלי יכול ליצור אינטראקציה עם 'עולם פתוח' של ישויות חיצוניות. אם הערך הוא false, הכלי יכול ליצור אינטראקציה רק עם ישויות פנימיות. לדוגמה, כלי לחיפוש באינטרנט יהיה עולם פתוח, אבל כלי לזיכרון לא יהיה עולם פתוח.

רמז הרסני: ❌ | רמז אידמפוטנטי: ✅ | רמז לקריאה בלבד: ✅ | רמז לעולם פתוח: ❌

היקפי הרשאות

נדרש אחד מהיקפי ההרשאות הבאים של OAuth:

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