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)

ไม่บังคับ ระบุการเป็นสมาชิกชุดย่อยที่จะแสดง หากไม่ระบุ ระบบจะแสดงเฉพาะการเป็นสมาชิกที่มีสถานะ JOINED

MembershipFilter

ระบุการเป็นสมาชิกชุดย่อยที่จะแสดง

Enum
MEMBERSHIP_FILTER_UNSPECIFIED ค่าเริ่มต้น หากไม่ระบุ ระบบจะแสดงเฉพาะการเป็นสมาชิกที่มีสถานะ JOINED
JOINED_ONLY แสดงเฉพาะการเป็นสมาชิกที่มีสถานะ JOINED
JOINED_AND_INVITED แสดงการเป็นสมาชิกที่มีสถานะ JOINED และ INVITED

สคีมาเอาต์พุต

การตอบกลับที่มีรายการการเป็นสมาชิกในการสนทนา

ListMembershipsResponse

การแสดง JSON 
{
  "memberships": [
    {
      object (Membership)
    }
  ],
  "nextPageToken": string
}
ช่อง
memberships[]

object (Membership)

รายการการเป็นสมาชิกในการสนทนาที่ขอ
nextPageToken

string

โทเค็นที่ส่งเป็น page_token เพื่อดึงข้อมูลหน้าถัดไปได้ หากไม่ระบุช่องนี้ แสดงว่าไม่มีหน้าถัดไป

Membership

การแสดง JSON 
{
  "member": {
    object (User)
  },
  "state": enum (State),
  "role": enum (Role)
}
ช่อง
member

object (User)

ผู้ใช้ที่เป็นสมาชิก
state

enum (State)

เอาต์พุตเท่านั้น สถานะการเป็นสมาชิก
role

enum (Role)

บทบาทของสมาชิก

User

การแสดง 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 ผู้ใช้ได้รับเชิญให้เข้าร่วมพื้นที่ทำงาน

Role

บทบาทของสมาชิก

Enum
ROLE_UNSPECIFIED ไม่ระบุ
MEMBER ผู้ใช้เป็นสมาชิกของพื้นที่ทำงาน
MANAGER ผู้ใช้เป็นผู้จัดการของพื้นที่ทำงาน
ASSISTANT_MANAGER ผู้ใช้เป็นผู้ช่วยผู้จัดการของพื้นที่ทำงาน

คำอธิบายประกอบของเครื่องมือ

ระบบจะส่งคำอธิบายประกอบของเครื่องมือไปยังไคลเอ็นต์ MCP เพื่ออธิบายความเสี่ยงพื้นฐานของเครื่องมือที่ระบุ ไคลเอ็นต์ส่วนใหญ่จะถือว่าคำแนะนำเหล่านี้ไม่น่าเชื่อถือ แต่สามารถใช้เพื่อตัดสินใจว่าจะส่งข้อความแจ้งการยืนยันไปยังผู้ใช้เมื่อใด

นอกจากสตริงชื่อแล้ว ระบบยังกำหนดคำแนะนำแบบบูลีนต่อไปนี้ไว้ด้วย

  • readOnlyHint: หากเป็นจริง แสดงว่าเครื่องมือจะไม่แก้ไขสภาพแวดล้อม ค่าเริ่มต้น: เท็จ
  • destructiveHint: หากเป็นจริง แสดงว่าเครื่องมือสามารถดำเนินการที่อาจทำให้เกิดความเสียหายได้ หากเป็นเท็จ แสดงว่าเครื่องมือสามารถดำเนินการที่เพิ่มข้อมูลเท่านั้น ค่าเริ่มต้น: จริง
  • idempotentHint: หากเป็นจริง การเรียกเครื่องมือซ้ำๆ ด้วยอาร์กิวเมนต์เดียวกันจะไม่มีผลเพิ่มเติมต่อสภาพแวดล้อม ค่าเริ่มต้น: เท็จ
  • openWorldHint: หากเป็นจริง แสดงว่าเครื่องมือสามารถโต้ตอบกับ "โอเพนเวิลด์" ของเอนทิตีภายนอกได้ หากเป็นเท็จ แสดงว่าเครื่องมือสามารถโต้ตอบกับเอนทิตีภายในเท่านั้น ตัวอย่างเช่น เครื่องมือค้นหาเว็บจะเป็นโอเพนเวิลด์ แต่เครื่องมือหน่วยความจำจะไม่เป็นโอเพนเวิลด์

คำแนะนำที่อาจทำให้เกิดความเสียหาย: ❌ | คำแนะนำที่อาจทำให้เกิดความเสียหายซ้ำ: ✅ | คำแนะนำแบบอ่านอย่างเดียว: ✅ | คำแนะนำแบบโลกเปิด: ❌

ขอบเขตการให้สิทธิ์

ต้องใช้ขอบเขต OAuth อย่างใดอย่างหนึ่งต่อไปนี้

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