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

必需。要列出成员资格的对话的 ID。格式：spaces/{space}
pageSize

integer

可选。要返回的最大会员数。服务返回的值可能小于此值。如果未指定或设置为非正值，则使用默认值 20。允许的最大值为 50。
pageToken

string

可选。从之前的 list_memberships 调用中收到的页面令牌。利用其进行后续页面检索。
membershipFilter

enum (MembershipFilter)

可选。指定要返回的会员资格子集。如果未指定，则仅返回 JOINED 会员资格。

MembershipFilter

指定要返回的会员资格子集。

枚举
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 用户的类型。

枚举
USER_TYPE_UNSPECIFIED 未指定。
HUMAN 人类用户。
APP 应用用户。

州

会员资格的状态。

枚举
STATE_UNSPECIFIED 未指定。
JOINED 用户是聊天室的成员。
INVITED 邀请用户加入聊天室。

角色

成员的角色。

枚举
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