工具:search_messages
使用关键字和过滤条件搜索 Google Chat 消息,并以 Markdown 格式返回搜索结果。适用于用户有权访问的所有聊天室,也可以限定为特定对话。
在决定是使用 search_messages 还是其他搜索或阅读工具时,请遵循以下指导:
- 当您要查找特定消息内容、关键字、提及内容、链接、发件人或未读消息时,可以使用
search_messages,这些消息可能位于多个聊天室中,也可能没有已知的对话 ID。 - 如果您知道具体的聊天室或消息串 ID,并且想要按时间顺序依次读取消息,请使用
list_messages。 - 使用
search_conversations可按聊天室显示名称或参与者查找聊天室元数据(例如对话 ID)(它仅搜索元数据,而不搜索消息内容)。
如果提供了 searchParameters 但未提供具体过滤条件,则返回用户可访问的对话中的近期消息。
以下代码示例展示了如何使用 curl 调用 search_messages MCP 工具。
| 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": "search_messages", "arguments": { // provide these details according to the tool MCP specification } }, "jsonrpc": "2.0", "id": 1 }' |
输入架构
SearchMessagesRequest
| JSON 表示法 |
|---|
{
"searchParameters": {
object ( |
| 字段 | |
|---|---|
searchParameters |
必需。用于搜索的搜索参数。 |
pageSize |
可选。要返回的结果数上限(最多为 100)。如果未指定,则最多返回 25 个。 |
pageToken |
可选。从之前的 |
SearchParameters
| JSON 表示法 |
|---|
{ "keywords": [ string ], "conversationId": string, "sender": string, "isUnread": boolean, "hasLink": boolean, "startTime": string, "endTime": string, "mentionsMe": boolean, "conversationIncludesUser": string, "spaceDisplayNames": [ string ] } |
| 字段 | |
|---|---|
keywords[] |
可选。用于过滤结果的一组关键字。 |
conversationId |
可选。将搜索范围限定为特定的对话标识符,如 search_conversations 工具返回的标识符。格式: |
sender |
可选。过滤来自特定用户的消息。可以使用发件人的电子邮件地址或资源名称。用户资源名称的格式为 |
isUnread |
可选。过滤掉未被调用用户读取的邮件。 |
hasLink |
可选。过滤包含至少一个网址的消息。 |
startTime |
可选。过滤在此时间之后创建的消息。格式:ISO 8601 时间戳。 |
endTime |
可选。过滤在此时间之前创建的消息。格式:ISO 8601 时间戳。 |
mentionsMe |
可选。过滤出明确提及调用用户的消息。 |
conversationIncludesUser |
可选。过滤私信和群组对话中包含特定用户电子邮件地址或 ID 的消息。 |
spaceDisplayNames[] |
可选。按聊天室名称列表过滤;聊天室显示名称部分匹配。注意:系统仅返回前 5 个匹配项。 |
输出架构
搜索 Google Chat 消息的响应。如果 next_page_token 已填充,则可以使用该令牌再次调用 SearchMessages 来检索下一页结果。
SearchMessagesResponse
| JSON 表示法 |
|---|
{
"messages": [
{
object ( |
| 字段 | |
|---|---|
messages[] |
符合搜索条件的消息对象列表。 |
nextPageToken |
可作为 |
ChatMessage
| JSON 表示法 |
|---|
{ "messageId": string, "threadId": string, "plaintextBody": string, "sender": { object ( |
| 字段 | |
|---|---|
messageId |
消息的资源名称。格式:spaces/{space}/messages/{message} |
threadId |
相应邮件所属的对话串。如果消息未归入任何对话串,则此项为空。格式:spaces/{space}/threads/{thread} |
plaintextBody |
使用 Markdown 格式设置的消息正文。 |
sender |
消息的发送者。 |
createTime |
仅限输出。消息的创建时间戳。 |
threadedReply |
消息是否为消息串回复。 |
attachments[] |
邮件中包含的附件。 |
reactionSummaries[] |
消息中包含的表情符号回应摘要。 |
用户
| JSON 表示法 |
|---|
{
"userId": string,
"displayName": string,
"email": string,
"userType": enum ( |
| 字段 | |
|---|---|
userId |
Chat 用户的资源名称。格式:users/{user}。 |
displayName |
Chat 用户的显示名称。 |
email |
用户的电子邮件地址。仅当用户类型为 HUMAN 时,系统才会填充此字段。 |
userType |
用户类型。 |
ChatAttachmentMetadata
| JSON 表示法 |
|---|
{
"attachmentId": string,
"filename": string,
"mimeType": string,
"source": enum ( |
| 字段 | |
|---|---|
attachmentId |
附件的资源名称。格式:spaces/{space}/messages/{message}/attachments/{attachment}。 |
filename |
附件的名称。 |
mimeType |
内容类型(MIME 类型)。 |
source |
附件的来源。 |
ReactionSummary
| JSON 表示法 |
|---|
{ "emoji": string, "count": integer } |
| 字段 | |
|---|---|
emoji |
表情符号 Unicode 字符串或自定义表情符号名称。 |
count |
使用关联表情符号回应的总次数。 |
UserType
Google Chat 用户的类型。
| 枚举 | |
|---|---|
USER_TYPE_UNSPECIFIED |
未指定。 |
HUMAN |
人类用户。 |
APP |
应用用户。 |
来源
附件的来源。
| 枚举 | |
|---|---|
SOURCE_UNSPECIFIED |
已预留。 |
DRIVE_FILE |
相应文件是 Google 云端硬盘文件。 |
UPLOADED_CONTENT |
文件已上传到 Chat。 |
工具注释
工具注释会发送给 MCP 客户端,用于描述指定工具的基本风险。大多数客户端会将这些提示视为不受信任的,但它们可用于确定何时向用户发送确认提示。
除了标题字符串之外,还定义了以下布尔值提示:
readOnlyHint:如果为 true,则工具不会修改其环境。默认值:false。destructiveHint:如果为 true,则工具可以执行破坏性操作。如果为 false,则该工具只能执行添加操作。默认值:true。idempotentHint:如果为 true,则使用相同实参重复调用该工具不会对其环境产生任何额外影响。默认值:false。openWorldHint:如果为 true,则工具可以与外部实体的“开放世界”进行交互。如果为 false,则该工具只能与内部实体互动。例如,网络搜索工具是开放世界工具,而内存工具不是开放世界工具。
破坏性提示:❌ | 等幂性提示:✅ | 只读提示:✅ | 开放世界提示:❌
授权范围
需要以下 OAuth 范围之一:
https://www.googleapis.com/auth/chat.messages.readonlyhttps://www.googleapis.com/auth/chat.spaces.readonlyhttps://www.googleapis.com/auth/chat.memberships.readonlyhttps://www.googleapis.com/auth/chat.users.readstate.readonly