MCP Reference: dataform.googleapis.com

שרת ה-MCP של Dataform מספק כלים לאינטראקציה עם Dataform.

שרת Model Context Protocol‏ (MCP) פועל כשרת proxy בין שירות חיצוני שמספק הקשר, נתונים או יכולות למודל שפה גדול (LLM) או לאפליקציית AI. שרתי MCP מחברים אפליקציות AI למערכות חיצוניות כמו מסדי נתונים ושירותי אינטרנט, ומתרגמים את התשובות שלהם לפורמט שאפליקציית ה-AI יכולה להבין.

הגדרת השרת

לפני שמשתמשים בשרתי MCP, צריך להפעיל אותם ולהגדיר אימות. מידע נוסף על שימוש בשרתי MCP מרוחקים של Google ו-Google Cloud זמין במאמר סקירה כללית על שרתי MCP של Google Cloud.

נקודות קצה של שרת

נקודת קצה של שירות MCP היא כתובת הרשת וממשק התקשורת (בדרך כלל כתובת URL) של שרת ה-MCP, שאפליקציית AI (המארח של לקוח ה-MCP) משתמשת בהם כדי ליצור חיבור מאובטח וסטנדרטי. הוא משמש כנקודת קשר למודל ה-LLM כדי לבקש הקשר, להפעיל כלי או לגשת למשאב. נקודות הקצה של Google MCP יכולות להיות גלובליות או אזוריות.

לשרת ה-MCP של Dataform API יש את נקודת הקצה הגלובלית הבאה של MCP:

  • https://dataform.googleapis.com/mcp

כלי MCP

כלי MCP הוא פונקציה או יכולת הפעלה ששרת MCP חושף למודל שפה גדול (LLM) או לאפליקציית AI כדי לבצע פעולה בעולם האמיתי.

כלים

לשרת ה-MCP ‏dataform.googleapis.com יש את הכלים הבאים:

כלי MCP
list_repositories

הצגת רשימה של מאגרי Dataform בפרויקט בענן ובמיקום נתונים מסוימים ב-Google Cloud.

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

create_repository

יוצרים מאגר Dataform חדש בפרויקט בענן ובמיקום נתונים מסוימים ב-Google Cloud.

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

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

ערך הפרמטר repository_id הוא המזהה שבו צריך להשתמש עבור המאגר.

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

commit_repository_changes

מחילים Git commit כדי לתעד את מצב הקבצים במאגר Dataform.

הכלי הזה מיועד בעיקר לניהול נכסים של קובץ יחיד – כמו מחברות או שאילתות שמורות – שנמצאים ישירות במאגר. לא משתמשים בכלי הזה בתהליכי עבודה רגילים של צינורות נתונים שדורשים סביבות עבודה.

אל תשתמשו בכלי הזה במאגרי קוד שמחוברים למארח Git מרוחק. כדי לאמת את העסק, צריך להשתמש בכלי get_repository. אם השדה git_remote_settings מופיע, המאגר מחובר למארח מרוחק, ולכן צריך להשתמש בכלים מבוססי סביבת עבודה כמו commit_workspace_changes.

פעולת השמירה הזו יוצרת רשומה קבועה בהיסטוריית ה-Git הפנימית של המאגר.

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

read_repository_file

החזרת התוכן של קובץ שנמצא במאגר Dataform.

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

אל תשתמשו בכלי הזה במאגרי קוד שמחוברים למארח Git מרוחק. כדי לאמת את העסק, צריך להשתמש בכלי get_repository. אם השדה git_remote_settings מופיע, המאגר מחובר למארח מרוחק, ואתם צריכים להשתמש בכלי read_file כדי לקרוא את הקובץ מסביבת עבודה.

ערך הפרמטר name מתייחס למאגר וחייב להיות בפורמט projects/{project_id}/locations/{location}/repositories/{repository}.

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

query_repository_directory_contents

החזרת התוכן של ספרייה נתונה במאגר Dataform.

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

אל תשתמשו בכלי הזה במאגרי קוד שמחוברים למארח Git מרוחק. כדי לאמת את העסק, צריך להשתמש בכלי get_repository. אם השדה git_remote_settings מופיע, המאגר מחובר למארח מרוחק, ואתם צריכים להשתמש בכלי query_directory_contents כדי להציג רשימה של ספריית סביבת עבודה.

ערך הפרמטר name מתייחס למאגר בפורמט projects/{project_id}/locations/{location}/repositories/{repository}.

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

list_workflow_configs

הצגת רשימה של הגדרות תהליכי עבודה במאגר Dataform נתון.

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

get_workflow_config

אחזור של הגדרה יחידה של תהליך עבודה ב-Dataform.

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

create_workflow_config

יוצרים הגדרה חדשה של תהליך עבודה במאגר Dataform נתון.

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

‫workflow_config_id הוא המזהה של הגדרת תהליך העבודה.

הגדרת זרימת עבודה משייכת בין ReleaseConfig לבין לוח זמנים וזהות. הכלי ReleaseConfig קובע איזה קוד עובר קומפילציה, והכלי הזה קובע מתי הקוד הזה יפעל ואיזה חשבון שירות יפעיל אותו.

דרישה מוקדמת: קודם צריך ליצור ReleaseConfig באמצעות הכלי create_release_config. צריך לציין את ערך הפרמטר workflow_config.release_config, אחרת הבקשה תיכשל.

הפעלות של תהליך העבודה שנוצרו מהגדרת תהליך העבודה הזו פועלות במסגרת חשבון שירות מותאם אישית. כדי לציין את חשבון השירות הזה, צריך להגדיר את ערך הפרמטר invocationConfig.serviceAccount. אם לא מציינים את האפשרות הזו, ההפעלות יחזרו לשימוש ב-service_account של המאגר. חשבון השירות לא יכול להיות סוכן השירות שמוגדר כברירת מחדל ב-Dataform. לחשבון השירות צריכות להיות ההרשאות הנדרשות להרצת תהליך העבודה, ולמשתמש צריכה להיות הרשאה לפעול בשם החשבון שנבחר. בדרך כלל, ההרשאה הזו ניתנת באמצעות תפקיד ה-IAM 'משתמש בחשבון שירות' (roles/iam.serviceAccountUser), שאפשר להעניק אותו בחשבון השירות עצמו או בפרויקט שמכיל אותו.

update_workflow_config

עדכון המאפיינים של הגדרת תהליך עבודה קיימת ב-Dataform, כמו תזמון ההרצה (cron), הגדרת הגרסה המשויכת או ביטולי ברירת המחדל של ההפעלה.

שינויים ב-cron_schedule נכנסים לתוקף באופן מיידי בכל ההפעלות העתידיות המתוזמנות.

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

חובה לציין את ערך הפרמטר workflow_config.release_config בכל עדכון. משתמשים בכלי get_workflow_config כדי לקרוא את הגדרת תהליך העבודה הנוכחית, וכוללים את הערך release_config שלה בבקשת העדכון.

הפעלות של תהליך העבודה שנוצרו מהגדרת תהליך העבודה הזו פועלות במסגרת חשבון שירות מותאם אישית. כדי לציין את חשבון השירות הזה, צריך להגדיר את ערך הפרמטר invocationConfig.serviceAccount. אם לא מציינים את האפשרות הזו, ההפעלות יחזרו לשימוש ב-service_account של המאגר. חשבון השירות לא יכול להיות סוכן השירות שמוגדר כברירת מחדל ב-Dataform. לחשבון השירות צריכות להיות ההרשאות הנדרשות להרצת תהליך העבודה, ולמשתמש צריכה להיות הרשאה לפעול כחשבון השירות שנבחר. בדרך כלל, ההרשאה הזו ניתנת באמצעות תפקיד ה-IAM 'משתמש בחשבון שירות' (roles/iam.serviceAccountUser), שאפשר להעניק אותו בחשבון השירות עצמו או בפרויקט שמכיל אותו.

list_release_configs

הצגת רשימה של הגדרות הפצה במאגר Dataform נתון.

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

get_release_config

שליפה של הגדרת פרסום אחת של Dataform.

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

create_release_config

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

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

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

משמיטים את ערך הפרמטר release_config.cron_schedule במאגרי מידע שמתארחים ב-Google. כדי לאמת את העסק, צריך להשתמש בכלי get_repository. אם השדה git_remote_settings חסר, המאגר מתארח ב-Google. כדי לתזמן את צינור עיבוד הנתונים, מגדירים את התזמון באמצעות הכלי create_workflow_config.

update_release_config

עדכון של הגדרת גרסה קיימת ב-Dataform, שמשמשת כתבנית להידור אוטומטי של קוד.

עדכונים בשדות כמו git_commitish משנים את האופן שבו נוצרים תוצאות קומפילציה עתידיות, אבל עדכונים כאלה לא משנים באופן רטרואקטיבי נכסי CompilationResult קיימים.

כשמעדכנים מאגרי מידע שמתארחים ב-Google, לא מציינים את הערך של הפרמטר release_config.cron_schedule. כדי לאמת את העסק, צריך להשתמש בכלי get_repository. אם השדה git_remote_settings חסר, המאגר מתארח ב-Google. כדי לתזמן את צינור הנתונים, מגדירים או מעדכנים את התזמון באמצעות הכלים create_workflow_config או update_workflow_config.

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

create_compilation_result

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

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

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

נציגים יכולים לאמת את ה-SQL שעבר קומפילציה על ידי בדיקת משאבי CompilationResultAction, ואולי להשתמש בכלי BigQuery להרצה יבשה.

כדי להפעיל תהליך עבודה ידני באמצעות הכלי create_workflow_invocation, צריך קודם לקבל תוצאת קומפילציה תקינה.

דרישה מוקדמת: צריך ליצור מאגר באמצעות הכלי create_repository לפני שמפעילים את הכלי create_compilation_result.

list_workflow_invocations

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

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

create_workflow_invocation

יצירת הפעלה חדשה של תהליך עבודה במאגר Dataform נתון.

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

צריך לציין את ערך הפרמטר compilation_result או workflow_config.

  • אם משתמשים ב-compilation_result, ערך הפרמטר צריך להיות בפורמט projects/{project_id}/locations/{location}/repositories/{repository}/compilationResults/{compilation_result}.
  • אם משתמשים ב-workflow_config, ערך הפרמטר צריך להיות בפורמט projects/{project_id}/locations/{location}/repositories/{repository}/workflowConfigs/{workflow_config}.

דרישה מוקדמת: כדי להפעיל קריאה לפונקציה, קודם צריך ליצור compilation_result באמצעות הכלי create_compilation_result או workflow_config באמצעות הכלי create_workflow_config. אי אפשר להפעיל קריאה לפונקציה ישירות מקוד מאגר גולמי.

הפעלת תהליך העבודה מתבצעת באמצעות חשבון שירות שנקבע על ידי מקור הקומפילציה:

  • אם משתמשים בפרמטר compilation_result, צריך להגדיר את ערך הפרמטר invocationConfig.serviceAccount. אם לא מציינים את המאפיין הזה, המערכת משתמשת בברירת המחדל של המאגר service_account.
  • אם משתמשים ב-workflow_config, לא מגדירים את הפרמטר invocationConfig. ההפעלה מתבצעת אוטומטית במסגרת חשבון השירות שהוגדר בתצורת תהליך העבודה.

חשבון השירות לא יכול להיות סוכן השירות שמוגדר כברירת מחדל ב-Dataform. לחשבון השירות צריכות להיות ההרשאות הנדרשות להרצת תהליך העבודה, ולמשתמש צריכה להיות הרשאה לפעול כחשבון השירות שנבחר. בדרך כלל, ההרשאה הזו ניתנת באמצעות התפקיד 'משתמש בחשבון שירות' (roles/iam.serviceAccountUser), שאפשר להעניק אותו לחשבון השירות עצמו או לפרויקט שמכיל אותו.

cancel_workflow_invocation

שליחת בקשה לסיום תקין של הפעלה של תהליך עבודה ב-Dataform.

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

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

get_compilation_result

שליפה של תוצאת הידור (compilation) יחידה ב-Dataform.

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

query_compilation_actions

מחזירה את הפעולות של תוצאת ההידור (compilation) של Dataform.

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

query_workflow_invocation_actions

מחזירה את הפעולות של הפעלת תהליך העבודה להפעלת תהליך עבודה נתון ב-Dataform.

הפעולות האלה מייצגות את המשימות הנפרדות ב-BigQuery, את יצירת הטבלאות או את ההצהרות שמרכיבות את תהליך העבודה.

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

get_workflow_invocation

אחזור של הפעלה יחידה של תהליך עבודה ב-Dataform.

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

list_workspaces

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

מומלץ להשתמש בכלי הזה כדי לגלות סביבות עבודה קיימות לפני שמבצעים פעולות על קבצים (באמצעות כלים כמו read_file או write_file) או שולחים קוד (באמצעות כלי כמו commit_workspace_changes).

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

get_workspace

אחזור של סביבת פיתוח יחידה ב-Dataform.

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

אם אתם לא יודעים את השם המדויק של סביבת העבודה, אתם יכולים להשתמש בכלי list_workspaces כדי למצוא אותו.

create_workspace

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

סביבת עבודה היא עותק מבודד של המאגר שאפשר לערוך. כדאי להשתמש בסביבת עבודה כשצריך לכתוב או לשנות קוד של צינורות בכמה קבצים, ולאמת אותו לפני שמבצעים commit. עורכים קבצים בסביבת העבודה באמצעות הכלים write_file ו-remove_file, מתעדים את התוצאה באמצעות הכלי commit_workspace_changes ומפרסמים את השינויים שנשמרו במאגר באמצעות הכלי push_git_commits.

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

תנאי מוקדם: מאגר האב חייב להתקיים.

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

ערך הפרמטר workspace_id הוא המזהה שבו צריך להשתמש בשביל סביבת העבודה.

ערך הפרמטר workspace מכיל את סביבת העבודה שרוצים ליצור.

query_directory_contents

החזרת התוכן של ספרייה נתונה בתוך סביבת עבודה של Dataform.

אפשר להשתמש בכלי הזה כדי לגלות נתיבי קבצים תקינים לפני שמפעילים את הכלים read_file או write_file.

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

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

search_files

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

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

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

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

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 ספציפית של הקובץ. אם לא מציינים את הערך הזה, מוחזר המצב הנוכחי של הקובץ שלא נשמר.

write_file

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

ערך הפרמטר contents שסופק מחליף את כל הקובץ, לכן כדאי לקרוא את התוכן הנוכחי באמצעות הכלי read_file לפני שמבצעים עריכה חלקית. השינויים לא נשמרים עד שמפעילים את הכלי commit_workspace_changes.

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

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

ערך הפרמטר contents חייב להיות מחרוזת בקידוד Base64 שמכילה את תוכן הקובץ.

remove_file

מחיקת קובץ בתוך סביבת עבודה של Dataform.

המחיקה לא מתבצעת עד שמפעילים את הכלי commit_workspace_changes.

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

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

make_directory

יוצרים ספרייה בסביבת עבודה של Dataform, כולל ספריות אב חסרות.

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

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

commit_workspace_changes

תיעוד של קומיט ב-Git לשינויים שלא בוצע להם קומיט בסביבת עבודה של Dataform.

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

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

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

ערך הפרמטר author מזהה את מחבר ה-Git שמתועד עבור הקומיט. צריך להוסיף גם author.name וגם author.email_address. מספקים את הערכים שמזהים את המשתמש שבשמו מתבצעת ההתחייבות. אל תשתמשו במחזיקי מקום, כי הם נכתבים בהיסטוריית ה-Git.

הערך של הפרמטר commit_message הוא ההודעה של השמירה.

push_git_commits

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

דרישה מוקדמת: לפני שמעלים את השינויים, צריך לאשר את העריכות במרחב העבודה באמצעות הכלי commit_workspace_changes. עריכות שלא בוצעו נשארות מקומיות ולא מועברות.

אם אתם מתכננים להשתמש בכלי create_release_config, אתם צריכים לשלוח את הקומיטים קודם. הגדרת גרסה פותרת את git_commitish שלה מול ה-Git remote, כך שענף או קומיט שקיימים רק בסביבת העבודה המקומית לא גלויים לה.

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

ערך הפרמטר remote_branch הוא הענף המרוחק שאליו רוצים לבצע push. אם לא מציינים את שם הענף, סביבת עבודה שמופעל בה ניהול ענפים מבצעת push לענף שמוגדר בה כרגע, וכל סביבת עבודה אחרת מבצעת push לענף ברירת המחדל שמוגדר במאגר.

get_repository

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

אפשר להשתמש בכלי הזה כדי לבדוק את השדה git_remote_settings ולקבוע איך ליצור אינטראקציה עם המאגר. אם השדה git_remote_settings מופיע, המאגר מחובר למארח Git מרוחק, מה שאומר שצריך להשתמש בכלים מבוססי סביבת עבודה לפיתוח צינורות, כמו create_workspace או commit_workspace_changes. אם השדה חסר, המאגר מתארח ב-Google. במקרה כזה, עדיין אפשר להשתמש בסביבות עבודה לפיתוח צינורות. לא מומלץ להשתמש בכלים ישירים של מאגרים כמו commit_repository_changes, אלא אם אתם מנהלים נכסים של קובץ יחיד.

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

אם אתם לא יודעים את השם המדויק של המאגר, אתם יכולים להשתמש בכלי list_repositories כדי למצוא אותו.

update_repository

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

תנאי מוקדם: לפני העדכון, צריך להשתמש בכלי get_repository כדי לקרוא את המצב הנוכחי של המאגר.

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

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

create_folder

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

התיקיות מארגנות את מאגרי Dataform בהיררכיה. יצירת תיקייה לא מעבירה אליה מאגרי מידע. כדי למקם מאגר בתוך תיקייה, צריך להגדיר את ערך הפרמטר containing_folder כשמשתמשים בכלי create_repository.

אל תנסו להעביר מאגר קיים לתיקייה באמצעות הכלי update_repository. אחרי שיוצרים מאגר, אי אפשר לשנות את השדה containing_folder שלו באמצעות כלי MCP.

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

צריך לציין את ערך הפרמטר folder.display_name, והוא מציין את השם הידידותי למשתמש של התיקייה.

קבלת מפרטים של כלי ה-MCP

כדי לקבל את המפרטים של כלי ה-MCP לכל הכלים בשרת MCP, משתמשים בשיטה tools/list. בדוגמה הבאה אפשר לראות איך משתמשים ב-curl כדי להציג רשימה של כל הכלים והמפרטים שלהם שזמינים כרגע בשרת MCP.

בקשת Curl
curl --location 'https://dataform.googleapis.com/mcp' \
--header 'content-type: application/json' \
--header 'accept: application/json, text/event-stream' \
--data '{
    "method": "tools/list",
    "jsonrpc": "2.0",
    "id": 1
}'