MCP Tools Reference: chatmcp.googleapis.com

כלי: search_messages

חיפוש הודעות ב-Google Chat באמצעות מילות מפתח ומסננים. ההגדרה פועלת בכל המרחבים שלמשתמש יש גישה אליהם, או שאפשר להגדיר אותה לשיחה ספציפית.

בדוגמה הבאה אפשר לראות איך משתמשים ב-curl כדי להפעיל את כלי ה-MCP‏ search_messages.

בקשת Curl
curl --location 'https://chatmcp.googleapis.com/mcp/v1' \
--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
}'
                

סכימת הקלט

אפשר לבקש לחפש הודעות ב-Google Chat באמצעות מילות מפתח ומסננים. ההגדרה פועלת בכל המרחבים שלמשתמש יש גישה אליהם, או שאפשר להגדיר אותה לשיחה ספציפית.

SearchMessagesRequest

ייצוג ב-JSON
{
  "searchParameters": {
    object (SearchParameters)
  },
  "orderBy": enum (OrderBy),
  "pageSize": integer,
  "pageToken": string
}
שדות
searchParameters

object (SearchParameters)

חובה. הפרמטרים של החיפוש שבהם רוצים להשתמש.

orderBy

enum (OrderBy)

אופציונלי. מציינת את הסדר שבו התוצאות צריכות להיות מוחזרות. ערכים נתמכים: CREATE_TIME_DESC,‏ CREATE_TIME_ASC או RELEVANCE_DESC. הערה: אי אפשר להשתמש ב-RELEVANCE_DESC כשמשתמשים במסנן is_unread. כברירת מחדל, נעשה שימוש ב-RELEVANCE_DESC אם is_unread לא מוגדר כ-true, אחרת נעשה שימוש ב-CREATE_TIME_DESC.

pageSize

integer

אופציונלי. המספר המקסימלי של תוצאות שיוחזרו (עד 100). אם לא מציינים ערך, מוחזרות לכל היותר 25 תוצאות.

pageToken

string

אופציונלי. טוקן של דף שהתקבל מקריאה קודמת של search_messages. צריך להזין את הטוקן כדי לאחזר את הדף הבא.

SearchParameters

ייצוג ב-JSON
{
  "keywords": [
    string
  ],
  "conversationId": string,
  "sender": string,
  "isUnread": boolean,
  "hasLink": boolean,
  "startTime": string,
  "endTime": string,
  "mentionsMe": boolean,
  "conversationIncludesUser": string,
  "spaceDisplayNames": [
    string
  ]
}
שדות
keywords[]

string

אופציונלי. קבוצה של מילות מפתח שמשמשות לסינון התוצאות.

conversationId

string

אופציונלי. מגדיר את היקף החיפוש למזהה שיחה ספציפי, כפי שמוחזר מהכלי search_conversations. פורמט: spaces/{ID}

sender

string

אופציונלי. סינון הודעות ממשתמש ספציפי. אפשר להשתמש בכתובת האימייל או בשם המשאב של השולח. שמות משאבי משתמשים מעוצבים כ-users/{ID}, כאשר {ID} יכול להיות מזהה של אדם או כתובת האימייל שלו.

isUnread

boolean

אופציונלי. סינון הודעות שהמשתמש שביצע את הקריאה לא קרא.

hasLink

boolean

אופציונלי. סינון הודעות שמכילות כתובת URL אחת לפחות.

startTime

string

אופציונלי. סינון הודעות שנוצרו אחרי השעה הזו. פורמט: חותמת זמן ISO 8601.

endTime

string

אופציונלי. סינון הודעות שנוצרו לפני השעה הזו. פורמט: חותמת זמן ISO 8601.

mentionsMe

boolean

אופציונלי. סינון הודעות שבהן המשתמש שמתקשר מוזכר באופן מפורש.

conversationIncludesUser

string

אופציונלי. מסננים הודעות בצ'אטים ישירים ובצ'אטים קבוצתיים שכוללים את כתובת האימייל או המזהה של המשתמש הספציפי.

spaceDisplayNames[]

string

אופציונלי. סינון לפי רשימה של שמות מרחבים. השמות לתצוגה של המרחבים תואמים באופן חלקי. הערה: המערכת מחזירה רק את 5 ההתאמות הטובות ביותר.

OrderBy

מציינת את הסדר שבו התוצאות צריכות להיות מוחזרות. כברירת מחדל, נעשה שימוש ב-RELEVANCE_DESC אם is_unread לא מוגדר כ-true, אחרת נעשה שימוש ב-CREATE_TIME_DESC.

טיפוסים בני מנייה (enum)
ORDER_BY_UNSPECIFIED ערך ברירת המחדל.
CREATE_TIME_DESC מיון לפי זמן היצירה בסדר יורד.
RELEVANCE_DESC מיון לפי רלוונטיות בסדר יורד.

סכימת פלט

תשובה לחיפוש הודעות ב-Google Chat. אם השדה next_page_token מאוכלס, אפשר לקרוא שוב ל-SearchMessages עם האסימון הזה כדי לאחזר את דף התוצאות הבא.

SearchMessagesResponse

ייצוג ב-JSON
{
  "messages": [
    {
      object (ChatMessage)
    }
  ],
  "nextPageToken": string
}
שדות
messages[]

object (ChatMessage)

רשימה של אובייקטים של הודעות שתואמים לקריטריוני החיפוש, מסודרים לפי פרמטר הבקשה order_by.

nextPageToken

string

טוקן שאפשר לשלוח כ-page_token כדי לאחזר את הדף הבא. אם משמיטים את השדה הזה, לא יופיעו דפים נוספים.

ChatMessage

ייצוג ב-JSON
{
  "messageId": string,
  "threadId": string,
  "plaintextBody": string,
  "sender": {
    object (User)
  },
  "createTime": string,
  "threadedReply": boolean,
  "attachments": [
    {
      object (ChatAttachmentMetadata)
    }
  ],
  "reactionSummaries": [
    {
      object (ReactionSummary)
    }
  ]
}
שדות
messageId

string

שם המשאב של ההודעה. פורמט: spaces/{space}/messages/{message}

threadId

string

השרשור שההודעה שייכת אליו. השדה הזה יהיה ריק אם ההודעה לא שייכת לשרשור. פורמט: spaces/{space}/threads/{thread}

plaintextBody

string

גוף ההודעה בטקסט רגיל.

sender

object (User)

השולח של ההודעה.

createTime

string

פלט בלבד. חותמת זמן של מועד יצירת ההודעה.

threadedReply

boolean

האם ההודעה היא תשובה בשרשור.

attachments[]

object (ChatAttachmentMetadata)

קבצים מצורפים שכלולים בהודעה.

reactionSummaries[]

object (ReactionSummary)

סיכום התגובות באמוג'י שמופיע בהודעה.

משתמש

ייצוג ב-JSON
{
  "userId": string,
  "displayName": string,
  "email": string,
  "userType": enum (UserType)
}
שדות
userId

string

שם המשאב של משתמש ב-Chat. פורמט: users/{user}

displayName

string

השם המוצג של המשתמש ב-Chat.

email

string

כתובת האימייל של המשתמש. השדה הזה מאוכלס רק כשסוג המשתמש הוא HUMAN.

userType

enum (UserType)

סוג המשתמש.

ChatAttachmentMetadata

ייצוג ב-JSON
{
  "attachmentId": string,
  "filename": string,
  "mimeType": string,
  "source": enum (Source)
}
שדות
attachmentId

string

שם המשאב של הקובץ המצורף. פורמט: spaces/{space}/messages/{message}/attachments/{attachment}.

filename

string

שם הקובץ המצורף.

mimeType

string

סוג התוכן (סוג MIME).

source

enum (Source)

המקור של הקובץ המצורף.

ReactionSummary

ייצוג ב-JSON
{
  "emoji": string,
  "count": integer
}
שדות
emoji

string

מחרוזת ה-Unicode של האמוג'י או שם האמוג'י בהתאמה אישית.

count

integer

המספר הכולל של התגובות באמצעות האמוג'י המשויך.

UserType

סוג המשתמש ב-Google Chat.

טיפוסים בני מנייה (enum)
USER_TYPE_UNSPECIFIED לא צוין.
HUMAN משתמש אנושי.
APP משתמש באפליקציה.

מקור

המקור של הקובץ המצורף.

טיפוסים בני מנייה (enum)
SOURCE_UNSPECIFIED שמורות.
DRIVE_FILE הקובץ הוא קובץ Google Drive.
UPLOADED_CONTENT הקובץ יועלה ל-Chat.

הערות על כלי

רמז הרסני: ❌ | רמז אידמפוטנטי: ✅ | רמז לקריאה בלבד: ✅ | רמז לעולם פתוח: ❌