工具:list_labels
列出经过身份验证的用户的 Gmail 账号中所有用户定义的标签。在调用 label_thread、unlabel_thread、label_message 或 unlabel_message 之前,使用此工具发现用户标签的 id。此工具不会返回系统标签,但可以使用其众所周知的 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 |
用于检索列表中下一页结果的令牌。 |
Label
| JSON 表示法 |
|---|
{
"labelId": string,
"name": string,
"color": {
object ( |
| 字段 | |
|---|---|
labelId |
标签的唯一标识符。 |
name |
标签的人类可读显示名称。 |
color |
可选。标签的颜色。 |
联合字段
|
|
threadsTotal |
标签下的线程总数。 |
联合字段
|
|
threadsUnread |
标签下的未读线程数。 |
LabelColor
| JSON 表示法 |
|---|
{ "textColor": string, "backgroundColor": string } |
| 字段 | |
|---|---|
textColor |
标签的文本颜色,以十六进制字符串(例如“#000000”)表示。仅允许使用以下预定义的一组颜色值: |
backgroundColor |
标签的背景颜色,以十六进制字符串(例如“#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