Эта страница переведена с помощью Cloud Translation API.

MCP Tools Reference: chatmcp.googleapis.com

Инструмент: `list_memberships`

Отображает список участников в чате Google.

Приведённый ниже пример кода демонстрирует, как использовать 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 }'

Запрос 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
}'

Схема ввода

Запрос на добавление в список участников

JSON-представление
{ "conversationId": string, "pageSize": integer, "pageToken": string, "membershipFilter": enum (`MembershipFilter`) }

Поля
`conversationId`	`string` Обязательно. Идентификатор беседы, для которой нужно вывести список участников. Формат: пробелы/{пробел}
`pageSize`	`integer` Необязательный параметр. Максимальное количество возвращаемых данных о членстве. Сервис может вернуть меньшее значение. Если параметр не указан или задан неположительным значением, используется значение по умолчанию 20. Максимально допустимое значение — 50.
`pageToken`	`string` Необязательный параметр. Токен страницы, полученный из предыдущего вызова функции list_memberships. Укажите его, чтобы получить следующую страницу.
`membershipFilter`	`enum ( MembershipFilter )` Необязательный параметр. Указывает подмножество возвращаемых членств. Если не указан, возвращаются только членства, объединенные в группу (JOINED).

MembershipFilter

Указывает подмножество значений, которые необходимо вернуть.

Перечисления
`MEMBERSHIP_FILTER_UNSPECIFIED`	Значение по умолчанию. Если не указано, возвращает только объединенные членства.
`JOINED_ONLY`	Возвращаются только зарегистрированные подписки.
`JOINED_AND_INVITED`	Возвращает статус "ПРИСОЕДИНЯЕТСЯ" и "ПРИГЛАШАЕТСЯ".

Схема вывода

Ответ, содержащий список участников беседы.

Ответ участников списка

JSON-представление
{ "memberships": [ { object (`Membership`) } ], "nextPageToken": string }

Поля

Поля
`memberships[]`	`object ( Membership )` Список участников запрошенной беседы.
`nextPageToken`	`string` Токен, который можно отправить в качестве `page_token` для получения следующей страницы. Если это поле опущено, последующих страниц не будет.

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 )` Роль участника.

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 )` Тип пользователя.

Тип пользователя

Тип пользователя 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