MCP Tools Reference: dataform.googleapis.com

כלי: read_file

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

אפשר להשתמש בכלי הזה כדי לקרוא את הקובץ workflow_settings.yaml של סביבת העבודה, שכולל את הגדרות הקומפילציה של צינור הנתונים, כמו מערך הנתונים ב-BigQuery שמוגדר כברירת מחדל, מיקום ברירת המחדל והגרסה של Dataform Core. הקובץ הזה נמצא בשורש של ספריית צינור הנתונים, שלא בהכרח נמצאת בשורש של סביבת העבודה, כי מאגר יכול להכיל כמה צינורות נתונים בספריות משנה. מאתרים את הקובץ באמצעות הכלי search_files.

כדי לקרוא קובץ שעבר קומיט ישירות מהמאגר בלי סביבת עבודה, משתמשים בכלי read_repository_file. הערה: read_repository_file פועל רק במאגרי מידע שלא מחוברים למארח Git מרוחק.

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

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

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

בדוגמת הקוד הבאה מוצג שימוש בפקודה curl כדי להפעיל את הכלי read_file 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": "read_file",
    "arguments": {
      // Provide these details according to the MCP tool specification.
    }
  },
  "jsonrpc": "2.0",
  "id": 1
}'

סכימת הקלט

ReadFile הזמנה לצ'אט.

ReadFileRequest

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

string

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

string

חובה. הנתיב המלא של הקובץ, כולל שם הקובץ, ביחס לשורש של סביבת העבודה.
revision

string

זה שינוי אופציונלי. מספר הגרסה של הקובץ ב-Git שרוצים להחזיר. אם השדה הזה יישאר ריק, יוחזר התוכן הנוכחי של path.

סכימת הפלט

ReadFile הודעת תגובה.

ReadFileResponse

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

string (bytes format)

תוכן הקובץ.

מחרוזת בקידוד Base64.

הערות על כלים

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

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

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

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