MCP Tools Reference: dataform.googleapis.com

כלי: get_release_config

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

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

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

סכימת הקלט

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

GetReleaseConfigRequest

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

string

חובה. השם של הגדרות המוצר.

סכימת הפלט

מייצג הגדרת גרסה ב-Dataform.

ReleaseConfig

ייצוג JSON 
{
  "name": string,
  "gitCommitish": string,
  "codeCompilationConfig": {
    object (CodeCompilationConfig)
  },
  "cronSchedule": string,
  "timeZone": string,
  "recentScheduledReleaseRecords": [
    {
      object (ScheduledReleaseRecord)
    }
  ],
  "releaseCompilationResult": string,
  "disabled": boolean,

  // Union field _internal_metadata can be only one of the following:
  "internalMetadata": string
  // End of list of possible types for union field _internal_metadata.
}
שדות
name

string

מזהה. השם של הגדרות המוצר.
gitCommitish

string

חובה. שם הקומיט/התג/הענף ב-Git שבו צריך לבצע קומפילציה של המאגר. הוא חייב להיות קיים במאגר המרוחק. דוגמאות: – SHA של קומיט: 12ade345 – תג: tag1 – שם של ענף: branch1
codeCompilationConfig

object (CodeCompilationConfig)

זה שינוי אופציונלי. אם השדה הזה מוגדר, השדות של code_compilation_config מבטלים את הגדרות הקומפילציה שמוגדרות כברירת מחדל בקובץ dataform.json.
cronSchedule

string

זה שינוי אופציונלי. תזמון אופציונלי (בפורמט cron) ליצירה אוטומטית של תוצאות ההידור.
timeZone

string

זה שינוי אופציונלי. מציין את אזור הזמן שישמש לפרשנות של cron_schedule. הערך חייב להיות שם של אזור זמן ממסד הנתונים של אזורי הזמן. אם לא מציינים ערך, ברירת המחדל היא UTC.
recentScheduledReleaseRecords[]

object (ScheduledReleaseRecord)

פלט בלבד. רשומות של 10 הניסיונות האחרונים של פרסום מתוזמן, מסודרות בסדר יורד של release_time. מתעדכן בכל פעם שהפעלה של cron_schedule גורמת ליצירה אוטומטית של תוצאת קומפילציה.
releaseCompilationResult

string

זה שינוי אופציונלי. השם של תוצאת הקומפילציה שפורסמה כרגע להגדרת הגרסה הזו. הערך הזה מתעדכן כשתוצאת קומפילציה נוצרת אוטומטית מהגדרת הגרסה הזו (באמצעות cron_schedule), או כשהמשאב הזה מתעדכן על ידי קריאה ל-API (יכול להיות כדי לחזור לגרסה קודמת). תוצאת ההידור חייבת להיווצר באמצעות הגדרת הגרסה הזו. חייב להיות בפורמט projects/*/locations/*/repositories/*/compilationResults/*.
disabled

boolean

זה שינוי אופציונלי. השבתה של יצירת תוצאות אוטומטית של אוספים.

שדה איחוד _internal_metadata.

הערך _internal_metadata יכול להיות רק אחד מהבאים:
internalMetadata

string

פלט בלבד. כל פרטי המטא-נתונים שמשמשים באופן פנימי להצגת המשאב. לדוגמה: חותמות זמן, דגלים, שדות סטטוס וכו'. הפורמט של השדה הזה הוא מחרוזת JSON.

CodeCompilationConfig

ייצוג JSON 
{
  "defaultDatabase": string,
  "defaultSchema": string,
  "defaultLocation": string,
  "assertionSchema": string,
  "vars": {
    string: string,
    ...
  },
  "databaseSuffix": string,
  "schemaSuffix": string,
  "tablePrefix": string,
  "builtinAssertionNamePrefix": string,
  "defaultNotebookRuntimeOptions": {
    object (NotebookRuntimeOptions)
  },
  "pipelineConfig": {
    object (PipelineConfig)
  }
}
שדות
defaultDatabase

string

זה שינוי אופציונלי. מסד הנתונים שמוגדר כברירת מחדל (מזהה הפרויקט ב-Google Cloud).
defaultSchema

string

זה שינוי אופציונלי. סכימת ברירת המחדל (מזהה מערך הנתונים ב-BigQuery).
defaultLocation

string

זה שינוי אופציונלי. מיקום ברירת המחדל ב-BigQuery שבו ייעשה שימוש. ברירת המחדל היא "US". רשימה מלאה של המיקומים זמינה במסמכי BigQuery: https://cloud.google.com/bigquery/docs/locations.
assertionSchema

string

זה שינוי אופציונלי. סכימת ברירת המחדל (מזהה מערך הנתונים ב-BigQuery) לאסרטיבים.
vars

map (key: string, value: string)

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

אובייקט שמכיל רשימה של "key": value זוגות. לדוגמה: { "name": "wrench", "mass": "1.3kg", "count": "3" }.
databaseSuffix

string

זה שינוי אופציונלי. הסיומת שצריך לצרף לכל השמות של מסדי הנתונים (מזהה פרויקט בענן של Google).
schemaSuffix

string

זה שינוי אופציונלי. הסיומת שצריך להוסיף לכל השמות של הסכימות (מזהה מערך הנתונים ב-BigQuery).
tablePrefix

string

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

string

זה שינוי אופציונלי. הקידומת שתוצמד לשמות של טענות מובנות.
defaultNotebookRuntimeOptions

object (NotebookRuntimeOptions)

זה שינוי אופציונלי. אפשרויות ברירת המחדל להפעלה של מחברת.
pipelineConfig

object (PipelineConfig)

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

VarsEntry

ייצוג JSON 
{
  "key": string,
  "value": string
}
שדות
key

string
value

string

NotebookRuntimeOptions

ייצוג JSON 
{
  "aiPlatformNotebookRuntimeTemplate": string,

  // Union field execution_sink can be only one of the following:
  "gcsOutputBucket": string
  // End of list of possible types for union field execution_sink.

  // Union field repository_snapshot_storage can be only one of the following:
  "gcsRepositorySnapshotDestination": {
    object (GcsRepositorySnapshotDestination)
  }
  // End of list of possible types for union field repository_snapshot_storage.
}
שדות
aiPlatformNotebookRuntimeTemplate

string

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

string

זה שינוי אופציונלי. המיקום ב-Google Cloud Storage שאליו יועלו התוצאות. פורמט: gs://bucket-name
שדה איחוד repository_snapshot_storage. יעד הצילום של קבצי המאגר שיהיו זמינים לגישה לקריאה בלבד בסביבת זמן ריצה של מחברת repository_snapshot_storage יכול להיות רק אחד מהבאים:
gcsRepositorySnapshotDestination

object (GcsRepositorySnapshotDestination)

זה שינוי אופציונלי. יעד Google Cloud Storage להעלאת התמונה. אם לא מציינים URI, ברירת המחדל היא gcs_output_bucket שצוין. פורמט: gs://bucket-name/path/

GcsRepositorySnapshotDestination

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

string

זה שינוי אופציונלי. יעד ב-Google Cloud Storage להעלאת תמונת המצב של המאגר. פורמט: gs://bucket-name/path/

PipelineConfig

ייצוג JSON 
{
  "pipelineType": enum (PipelineType),
  "path": string
}
שדות
pipelineType

enum (PipelineType)

חובה. סוג צינור העיבוד.
path

string

חובה. הנתיב היחסי במאגר Git שבו מוגדר צינור הנתונים. לדוגמה, בצינור Dataform, זהו הנתיב לתיקייה שבה נמצאים workflow_settings.yaml או dataform.json.

ScheduledReleaseRecord

ייצוג JSON 
{
  "releaseTime": string,

  // Union field result can be only one of the following:
  "compilationResult": string,
  "errorStatus": {
    object (Status)
  }
  // End of list of possible types for union field result.
}
שדות
releaseTime

string (Timestamp format)

פלט בלבד. חותמת הזמן של ניסיון הפרסום הזה.

הפונקציה משתמשת ב-RFC 3339, והפלט שנוצר תמיד יהיה בפורמט Z עם 0, 3, 6 או 9 ספרות אחרי הנקודה. אפשר להשתמש גם בהיסטים אחרים, לא רק ב-Z. דוגמאות: "2014-10-02T15:01:23Z", ‏ "2014-10-02T15:01:23.045123456Z" או "2014-10-02T15:01:23+05:30".
שדה איחוד result. התוצאה של ניסיון ההפצה הזה. הערך result יכול להיות רק אחד מהבאים:
compilationResult

string

השם של תוצאת ההידור שנוצרה, אם נוצרה כזו. חייב להיות בפורמט projects/*/locations/*/repositories/*/compilationResults/*.
errorStatus

object (Status)

סטטוס השגיאה שנתקלה בניסיון הזה ליצור את תוצאת ההידור, אם הניסיון לא הצליח.

סטטוס

ייצוג JSON 
{
  "code": integer,
  "message": string,
  "details": [
    {
      "@type": string,
      field1: ...,
      ...
    }
  ]
}
שדות
code

integer

קוד הסטטוס, שצריך להיות ערך enum של google.rpc.Code.
message

string

הודעת שגיאה שמוצגת למפתחים, שצריכה להיות באנגלית. כל הודעת שגיאה שמוצגת למשתמש צריכה להיות מותאמת לשפה המקומית ולהישלח בשדה google.rpc.Status.details, או להיות מותאמת לשפה המקומית על ידי הלקוח.
details[]

object

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

אובייקט שמכיל שדות מסוג שרירותי. שדה נוסף "@type" מכיל URI שמזהה את הסוג. לדוגמה: { "id": 1234, "@type": "types.example.com/standard/id" }.

הכול

ייצוג JSON 
{
  "typeUrl": string,
  "value": string
}
שדות
typeUrl

string

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

דוגמה: type.googleapis.com/google.protobuf.StringValue

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

הקידומת היא שרירותית, וההטמעות של Protobuf אמורות פשוט להסיר את כל מה שמופיע עד וכולל / האחרון כדי לזהות את הסוג. ‫type.googleapis.com/ היא תחילית ברירת מחדל נפוצה שנדרשת בחלק מההטמעות מדור קודם. הקידומת הזו לא מציינת את המקור של הסוג, ולא צפוי שמזהי URI שמכילים אותה יגיבו לבקשות כלשהן.

כל מחרוזות כתובות ה-URL של הסוג חייבות להיות הפניות חוקיות ל-URI, עם הגבלה נוספת (בפורמט הטקסט) שלפיה התוכן של ההפניה חייב לכלול רק תווים אלפאנומריים, תווים מיוחדים עם קידוד אחוזים ותווים מהקבוצה הבאה (לא כולל הגרשיים החיצוניים): /-.~_!$&()*+,;=. למרות שאנחנו מאפשרים קידודים באחוזים, בהטמעות לא צריך לבטל את הקידוד שלהם כדי למנוע בלבול עם מנתחים קיימים. לדוגמה, בקשה עם הערך type.googleapis.com%2FFoo צריכה להידחות.

בתכנון המקורי של Any, נשקלה האפשרות להפעיל שירות לפתרון סוגים בכתובות ה-URL האלה של הסוגים, אבל ב-Protobuf מעולם לא הוטמע שירות כזה, והפנייה לכתובות ה-URL האלה נחשבת לבעייתית ולבעיית אבטחה פוטנציאלית. אל תנסו ליצור קשר עם כתובות URL מסוגים שונים.
value

string (bytes format)

מכיל סריאליזציה של Protobuf של הסוג שמתואר על ידי type_url.

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

חותמת הזמן

ייצוג JSON 
{
  "seconds": string,
  "nanos": integer
}
שדות
seconds

string (int64 format)

מייצג את השניות של זמן UTC מאז ראשית זמן יוניקס (Unix epoch) ‏1970-01-01T00:00:00Z. הערך חייב להיות בין ‎-62135596800 ל-‎253402300799, כולל (שמתאים לטווח 0001-01-01T00:00:00Z עד 9999-12-31T23:59:59Z).
nanos

integer

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

PipelineType

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

טיפוסים בני מנייה (enum)
PIPELINE_TYPE_UNSPECIFIED ערך ברירת המחדל. הערך הזה לא בשימוש.
DATAFORM פייפליין רגיל של Dataform.
SQL נכס של קובץ SQL יחיד.
NOTEBOOK נכס של קובץ יחיד של מחברת.

הערות על כלים

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

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

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

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