MCP Tools Reference: dataform.googleapis.com

כלי: search_files

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

כדי לאתר קובץ לפי שם או סיומת במאגר גדול, מומלץ להשתמש בכלי הזה במקום בכלי query_directory_contents שמציג רשימה של ספריות באופן רקורסיבי.

ערך הפרמטר workspace צריך להיות בפורמט projects/{project_id}/locations/{location}/repositories/{repository}/workspaces/{workspace}.

ערך הפרמטר filter מגביל את התוצאות. הסינון נתמך רק בשדה path (לדוגמה, path="*.sqlx" או path="definitions/model.sqlx").

בדוגמת הקוד הבאה מוצג שימוש בפקודה curl כדי להפעיל את הכלי search_files MCP.

בקשת Curl 
curl --location 'https://dataform.googleapis.com/mcp' \
--header 'content-type: application/json' \
--header 'accept: application/json, text/event-stream' \
--data '{
  "method": "tools/call",
  "params": {
    "name": "search_files",
    "arguments": {
      // Provide these details according to the MCP tool specification.
    }
  },
  "jsonrpc": "2.0",
  "id": 1
}'

סכימת הקלט

הגדרה שמכילה פרמטרים של בקשת חיפוש קבצים.

SearchFilesRequest

ייצוג JSON 
{
  "workspace": string,
  "pageSize": integer,
  "pageToken": string,
  "filter": string
}
שדות
workspace

string

חובה. השם של סביבת העבודה.
pageSize

integer

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

string

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

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

string

זה שינוי אופציונלי. מסנן אופציונלי לרשימה שמוחזרת בפורמט סינון. בשלב הזה, סינון נתמך רק בשדה path. פרטים נוספים זמינים בכתובת https://google.aip.dev/160.

סכימת הפלט

ייצוג של תשובה לחיפוש קבצים שמוצג ללקוח.

SearchFilesResponse

ייצוג JSON 
{
  "searchResults": [
    {
      object (SearchResult)
    }
  ],
  "nextPageToken": string
}
שדות
searchResults[]

object (SearchResult)

רשימת התוצאות התואמות.
nextPageToken

string

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

SearchResult

ייצוג JSON 
{

  // Union field entry can be only one of the following:
  "file": {
    object (FileSearchResult)
  },
  "directory": {
    object (DirectorySearchResult)
  }
  // End of list of possible types for union field entry.
}
שדות
שדה איחוד entry. התוכן של הרשומה. הערך entry יכול להיות רק אחד מהבאים:
file

object (FileSearchResult)

פרטים כשתוצאת החיפוש היא קובץ.
directory

object (DirectorySearchResult)

פרטים כשתוצאת החיפוש היא ספרייה.

FileSearchResult

ייצוג JSON 
{
  "path": string
}
שדות
path

string

נתיב במערכת הקבצים ביחס לתיקיית הבסיס של סביבת העבודה.

DirectorySearchResult

ייצוג JSON 
{
  "path": string
}
שדות
path

string

נתיב במערכת הקבצים ביחס לתיקיית הבסיס של סביבת העבודה.

הערות על כלים

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

בנוסף למחרוזת הכותרת, מוגדרים הרמזים הבוליאניים הבאים:

  • ‫readOnlyHint: אם הערך הוא true, הכלי לא משנה את הסביבה שלו. ברירת מחדל: false.
  • ‫destructiveHint: אם הערך הוא True, הכלי יכול לבצע פעולות הרסניות. אם הערך הוא false, הכלי יכול לבצע רק פעולות של הוספה. ברירת מחדל: true.
  • ‫idempotentHint: אם הערך הוא true, קריאה חוזרת לכלי עם אותם ארגומנטים לא תשפיע על הסביבה שלו. ברירת מחדל: false.
  • ‫openWorldHint: אם הערך הוא true, הכלי יכול ליצור אינטראקציה עם 'עולם פתוח' של ישויות חיצוניות. אם הערך הוא false, הכלי יכול ליצור אינטראקציה רק עם ישויות פנימיות. לדוגמה, כלי לחיפוש באינטרנט יהיה עולם פתוח, אבל כלי לזיכרון לא יהיה עולם פתוח.

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