MCP Tools Reference: gmailmcp.googleapis.com

Công cụ: list_drafts

Liệt kê email nháp trong tài khoản Gmail của người dùng đã xác thực.

Công cụ này có thể lọc bản nháp dựa trên một chuỗi truy vấn và hỗ trợ phân trang. Phương thức này trả về danh sách các bản nháp, bao gồm cả mã nhận dạng và tiêu đề của bản nháp (trừ phi view được đặt thành DRAFT_VIEW_METADATA_ONLY). Bạn có thể dùng page_token để phân trang kết quả. Để truy xuất các trang kết quả tiếp theo, hãy sử dụng page_token được trả về trong phản hồi trước đó.

Tham số view kiểm soát những trường được điền sẵn trong phản hồi. Theo mặc định (hoặc với DRAFT_VIEW_FULL), phương thức này sẽ trả về toàn bộ nội dung. Sử dụng DRAFT_VIEW_METADATA_ONLY để loại trừ nội dung nhạy cảm như tiêu đề và nội dung.

Mẫu sau đây minh hoạ cách sử dụng curl để gọi công cụ MCP list_drafts.

Yêu cầu 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_drafts",
    "arguments": {
      // provide these details according to the tool's MCP specification
    }
  },
  "jsonrpc": "2.0",
  "id": 1
}'

Giản đồ đầu vào

Thông báo yêu cầu cho RPC ListDrafts.

ListDraftsRequest

Biểu diễn dưới dạng JSON 
{

  "pageSize": integer

  "pageToken": string

  "query": string

  "view": enum (DraftView)
}
Trường

Trường nhóm _page_size.

_page_size chỉ có thể là một trong những trạng thái sau:
pageSize

integer

Không bắt buộc. Số lượng bản nháp tối đa cần trả về. Nếu không được chỉ định, giá trị mặc định là 20. Giá trị tối đa được phép là 50.

Trường nhóm _page_token.

_page_token chỉ có thể là một trong những trạng thái sau:
pageToken

string

Không bắt buộc. Mã thông báo nhận được từ lệnh gọi list_drafts trước đó để truy xuất trang kết quả tiếp theo. Để trống để tìm nạp trang đầu tiên. Tham số này chủ yếu được dùng để phân trang nhằm tiếp tục tìm nạp kết quả từ nơi mà lệnh gọi ListDraft trước đó đã dừng lại, đặc biệt là khi số lượng bản nháp khớp với truy vấn vượt quá giới hạn page_size.

Trường nhóm _query.

_query chỉ có thể là một trong những trạng thái sau:
query

string

Ví dụ:

  • subject:OneMCP Update
  • from:gduser1@workspacesamples.dev
  • to:gduser2@workspacesamples.dev AND newer_than:7d
  • project proposal has:attachment
  • is:unread

Dấu cách hoặc dấu gạch ngang (-) sẽ phân tách một số trong khi dấu chấm (.) sẽ là phần thập phân. Ví dụ: 01.2047-100 được xem là 2 số: 01.2047 và 100.

Lưu ý: Nếu muốn đảm bảo tất cả bản nháp cho cụm từ tìm kiếm đều được trả về, chúng ta có thể phân trang kết quả bằng cách gọi công cụ nhiều lần cho đến khi phản hồi chứa một danh sách trống các bản nháp.

Trường nhóm _view.

_view chỉ có thể là một trong những trạng thái sau:
view

enum (DraftView)

Không bắt buộc. Kiểm soát các trường được điền sẵn cho bản nháp trong danh sách bản nháp. Theo mặc định (hoặc với DRAFT_VIEW_FULL), hàm này sẽ trả về nội dung đầy đủ, bao gồm mã nhận dạng bản nháp, threadID, to, cc, bcc, date, subject và body. Sử dụng DRAFT_VIEW_METADATA_ONLY để loại trừ tiêu đề và nội dung.

DraftView

Liệt kê để kiểm soát các trường được điền sẵn cho bản nháp trong phản hồi ListDrafts.

Enum
DRAFT_VIEW_UNSPECIFIED Ánh xạ đến DRAFT_VIEW_FULL để có khả năng tương thích ngược.
DRAFT_VIEW_METADATA_ONLY Chỉ có siêu dữ liệu: không bao gồm subject, plaintext_body, html_body.
DRAFT_VIEW_FULL Siêu dữ liệu + nội dung do người dùng tạo (Hành vi mặc định).

Giản đồ đầu ra

Thông báo phản hồi cho RPC ListDrafts.

ListDraftsResponse

Biểu diễn dưới dạng JSON 
{
  "drafts": [
    {
      object (Draft)
    }
  ],
  "nextPageToken": string
}
Trường
drafts[]

object (Draft)

Danh sách bản nháp.
nextPageToken

string

Một mã thông báo có thể dùng trong một lệnh gọi tiếp theo để truy xuất trang tiếp theo của bản nháp. Nếu số lượng bản nháp khớp với truy vấn vượt quá giới hạn page_size, thì phản hồi sẽ chứa một next_page_token. Để truy xuất trang kết quả tiếp theo, hãy truyền mã thông báo này vào trường page_token của ListDraftsRequest tiếp theo.

Bản nháp

Biểu diễn dưới dạng JSON 
{
  "id": string,
  "subject": string,
  "threadId": string,
  "toRecipients": [
    string
  ],
  "ccRecipients": [
    string
  ],
  "bccRecipients": [
    string
  ],
  "plaintextBody": string,
  "date": string,
  "htmlBody": string
}
Trường
id

string

Giá trị nhận dạng duy nhất của tài nguyên nháp.
subject

string

Dòng tiêu đề của thư nháp.
threadId

string

Mã của chuỗi mà bản nháp này thuộc về.
toRecipients[]

string

Danh sách địa chỉ email của người nhận trong trường "Đến" được trích xuất từ phần đầu thư.
ccRecipients[]

string

Danh sách địa chỉ email của người nhận "Cc" được trích xuất từ phần đầu thư.
bccRecipients[]

string

Danh sách địa chỉ email của người nhận "Bcc" được trích xuất từ phần đầu thư.
plaintextBody

string

Nội dung phần thân là văn bản thuần tuý (nếu có).
date

string

Ngày của bản nháp ở định dạng ISO 8601 (YYYY-MM-DD).
htmlBody

string

Nội dung phần thân HTML của bản nháp (nếu có).

Chú giải công cụ

Gợi ý mang tính huỷ diệt: ❌ | Gợi ý mang tính luỹ đẳng: ❌ | Gợi ý chỉ đọc: ✅ | Gợi ý về thế giới mở: ❌

Phạm vi cấp phép

Yêu cầu một trong các phạm vi OAuth sau:

  • https://mail.google.com/
  • https://www.googleapis.com/auth/gmail.modify
  • https://www.googleapis.com/auth/gmail.compose
  • https://www.googleapis.com/auth/gmail.readonly