ツール: list_labels
認証されたユーザーの Gmail アカウントで使用できるユーザー定義ラベルをすべて一覧表示します。このツールを使用して、ユーザーラベルの id を検出します。これは、label_thread、unlabel_thread、label_message、または unlabel_message を呼び出す前に行います。システムラベルはこのツールでは返されませんが、既知の ID('INBOX'、'TRASH'、'SPAM'、'STARRED'、'UNREAD'、'IMPORTANT'、'CHAT'、'DRAFT'、'SENT')で使用できます。
次のサンプルは、curl を使用して list_labels MCP ツールを呼び出す方法を示しています。
| Curl リクエスト |
|---|
curl --location 'https://gmailmcp.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_labels", "arguments": { // provide these details according to the tool's MCP specification } }, "jsonrpc": "2.0", "id": 1 }' |
入力スキーマ
ListLabels RPC に対するリクエスト メッセージ。
ListLabelsRequest
| JSON 表現 |
|---|
{ "pageSize": integer "pageToken": string } |
| フィールド | |
|---|---|
共用体フィールド
|
|
pageSize |
省略可。返すラベルの最大数。 |
共用体フィールド
|
|
pageToken |
省略可。リスト内の特定の結果ページを取得するためのページトークン。 |
出力スキーマ
ListLabels RPC に対するレスポンス メッセージ。
ListLabelsResponse
| JSON 表現 |
|---|
{
"labels": [
{
object ( |
| フィールド | |
|---|---|
labels[] |
ユーザー アカウントのユーザーラベルのリスト。 |
nextPageToken |
リスト内の結果の次のページを取得するためのトークン。 |
ラベル
| JSON 表現 |
|---|
{
"labelId": string,
"name": string,
"color": {
object ( |
| フィールド | |
|---|---|
labelId |
ラベルの一意の識別子。 |
name |
ラベルの表示名(人が読める形式)。 |
color |
省略可。ラベルの色。 |
共用体フィールド
|
|
threadsTotal |
ラベルの下にあるスレッドの総数。 |
共用体フィールド
|
|
threadsUnread |
ラベルの下にある未読スレッドの数。 |
LabelColor
| JSON 表現 |
|---|
{ "textColor": string, "backgroundColor": string } |
| フィールド | |
|---|---|
textColor |
ラベルのテキストの色。16 進文字列(例: 「#000000」)で表されます。使用できるのは、次の定義済みの色値セットのみです。 |
backgroundColor |
ラベルの背景色。16 進文字列(例: 「#ffffff」)で表されます。使用できるのは、次の定義済みの色値セットのみです。 |
ツールのアノテーション
破壊的ヒント: ❌ | べき等ヒント: ✅ | 読み取り専用ヒント: ✅ | オープン ワールド ヒント: ❌
認可スコープ
次の OAuth スコープのいずれかが必要です。
https://mail.google.com/https://www.googleapis.com/auth/gmail.modifyhttps://www.googleapis.com/auth/gmail.readonlyhttps://www.googleapis.com/auth/gmail.labelshttps://www.googleapis.com/auth/gmail.metadata