MCP Tools Reference: chatmcp.googleapis.com

Narzędzie: list_memberships

Wyświetla listę członków rozmowy w Google Chat.

Poniższy przykładowy kod pokazuje, jak użyć curl, aby wywołać narzędzie MCP list_memberships.

Żądanie 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
}'

Schemat wejściowy

ListMembershipsRequest

Zapis JSON
{
  "conversationId": string,
  "pageSize": integer,
  "pageToken": string,
  "membershipFilter": enum (MembershipFilter)
}
Pola
conversationId

string

Wymagane. Identyfikator rozmowy, dla której chcesz wyświetlić listę członków. Format: spaces/{space}

pageSize

integer

Opcjonalnie. Maksymalna liczba członków do zwrócenia. Usługa może zwrócić mniej niż ta wartość. Jeśli nie zostanie określona lub będzie miała wartość nie większą niż 0, zostanie użyta wartość domyślna 20. Maksymalna dozwolona wartość to 50.

pageToken

string

Opcjonalnie. Token strony otrzymany w poprzednim wywołaniu list_memberships. Podaj go, aby pobrać następną stronę.

membershipFilter

enum (MembershipFilter)

Opcjonalnie. Określa podzbiór członków do zwrócenia. Jeśli nie zostanie określony, zwracane są tylko członkostwa JOINED.

MembershipFilter

Określa podzbiór członków do zwrócenia.

Wartości w polu enum
MEMBERSHIP_FILTER_UNSPECIFIED Wartość domyślna. Jeśli nie zostanie określona, zwracane są tylko członkostwa JOINED.
JOINED_ONLY Zwraca tylko członkostwa JOINED.
JOINED_AND_INVITED Zwraca członkostwa JOINED i INVITED.

Schemat wyjściowy

Odpowiedź zawierająca listę członków rozmowy.

ListMembershipsResponse

Zapis JSON
{
  "memberships": [
    {
      object (Membership)
    }
  ],
  "nextPageToken": string
}
Pola
memberships[]

object (Membership)

Lista członków w żądanej rozmowie.

nextPageToken

string

Token, który można wysłać jako page_token, aby pobrać następną stronę. Jeśli pominiesz to pole, nie będzie kolejnych stron.

Członkostwo

Zapis JSON
{
  "member": {
    object (User)
  },
  "state": enum (State),
  "role": enum (Role)
}
Pola
member

object (User)

Użytkownik, który jest członkiem.

state

enum (State)

Tylko dane wyjściowe. Stan członkostwa.

role

enum (Role)

Rola członka.

Użytkownik

Zapis JSON
{
  "userId": string,
  "displayName": string,
  "email": string,
  "userType": enum (UserType)
}
Pola
userId

string

Nazwa zasobu użytkownika Chatu. Format: users/{user}.

displayName

string

Nazwa wyświetlana użytkownika Chatu.

email

string

Adres e-mail użytkownika. To pole jest wypełniane tylko wtedy, gdy typ użytkownika to HUMAN.

userType

enum (UserType)

Typ użytkownika.

UserType

Typ użytkownika Google Chat.

Wartości w polu enum
USER_TYPE_UNSPECIFIED Nie określono.
HUMAN Użytkownik.
APP Użytkownik aplikacji.

Stan

Stan członkostwa.

Wartości w polu enum
STATE_UNSPECIFIED Nie określono.
JOINED Użytkownik jest członkiem pokoju.
INVITED Użytkownik został zaproszony do dołączenia do pokoju.

Rola

Rola członka.

Wartości w polu enum
ROLE_UNSPECIFIED Nie określono.
MEMBER Użytkownik jest członkiem pokoju.
MANAGER Użytkownik jest menedżerem pokoju.
ASSISTANT_MANAGER Użytkownik jest asystentem menedżera pokoju.

Adnotacje narzędzia

Adnotacje narzędzia są wysyłane do klientów MCP, aby opisać podstawowe ryzyko związane z danym narzędziem. Większość klientów traktuje te wskazówki jako niezaufane, ale można ich użyć do określenia, kiedy należy wysłać do użytkownika prośbę o potwierdzenie.

Oprócz ciągu tytułu zdefiniowano te wskazówki logiczne:

  • readOnlyHint: jeśli ma wartość true, narzędzie nie modyfikuje swojego środowiska. Domyślnie: false.
  • destructiveHint: jeśli ma wartość true, narzędzie może wykonywać działania destrukcyjne. Jeśli ma wartość false, narzędzie może wykonywać tylko działania dodające. Domyślnie: true.
  • idempotentHint: jeśli ma wartość true, wielokrotne wywoływanie narzędzia z tymi samymi argumentami nie będzie miało dodatkowego wpływu na jego środowisko. Domyślnie: false.
  • openWorldHint: jeśli ma wartość true, narzędzie może wchodzić w interakcje z „otwartym światem” podmiotów zewnętrznych. Jeśli ma wartość false, narzędzie może wchodzić w interakcje tylko z podmiotami wewnętrznymi. Na przykład narzędzie do wyszukiwania w internecie byłoby narzędziem typu Otwarty świat, a narzędzie do zarządzania pamięcią – nie.

Wskazówka destrukcyjna: ❌ | Wskazówka idempotentna: ✅ | Wskazówka tylko do odczytu: ✅ | Wskazówka dotycząca otwartego świata: ❌

Zakresy autoryzacji

Wymaga jednego z tych zakresów OAuth:

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