REST Resource: projects.locations.apps.toolsets

מקור מידע: חבילת כלים

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

ייצוג ב-JSON 
{
  "name": string,
  "displayName": string,
  "description": string,
  "timeout": string,
  "createTime": string,
  "updateTime": string,
  "etag": string,
  "executionType": enum (ExecutionType),
  "toolFakeConfig": {
    object (ToolFakeConfig)
  },

  // The following is a list of mutually exclusive fields. At most one of the
  // fields will be set in a response:
  "mcpToolset": {
    object (McpToolset)
  },
  "openApiToolset": {
    object (OpenApiToolset)
  },
  "connectorToolset": {
    object (ConnectorToolset)
  }
  // End of mutually exclusive fields.
}
שדות
name

string

מזהה. המזהה הייחודי של ערכת הכלים. פורמט: projects/{project}/locations/{location}/apps/{app}/toolsets/{toolset}
displayName

string

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

string

זה שינוי אופציונלי. תיאור של ערכת הכלים.
timeout

string (Duration format)

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

משך זמן בשניות עם עד תשע ספרות אחרי הנקודה העשרונית, שמסתיים ב-s. דוגמה: "3.5s".
createTime

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".
updateTime

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".
etag

string

תג ETag שמשמש כדי לוודא שהאובייקט לא השתנה במהלך פעולת קריאה-שינוי-כתיבה. אם ה-etag ריק, העדכון יחליף את כל השינויים המקבילים.
executionType

enum (ExecutionType)

זה שינוי אופציונלי. סוג הביצוע של הכלים בערכת הכלים.
toolFakeConfig

object (ToolFakeConfig)

זה שינוי אופציונלי. הגדרות של אופן הפעולה של הכלים במצב מזויף.
סוג ערכת הכלים. הרשימה הבאה כוללת שדות שאי אפשר להשתמש בהם בו-זמנית. בכל תשובה יוגדר לכל היותר אחד מהשדות:
mcpToolset

object (McpToolset)

זה שינוי אופציונלי. ערכת כלים שמכילה רשימה של כלים שמוצעים על ידי שרת ה-MCP.
openApiToolset

object (OpenApiToolset)

זה שינוי אופציונלי. ערכת כלים שמכילה רשימה של כלים שמוגדרים על ידי סכימת OpenAPI.
connectorToolset

object (ConnectorToolset)

זה שינוי אופציונלי. ערכת כלים שיוצרת כלים מחיבור Integration Connectors.
סוף השדות הבלעדיים.

McpToolset

ערכת כלים שמכילה רשימה של כלים שמוצעים על ידי שרת ה-MCP.

ייצוג ב-JSON 
{
  "serverAddress": string,
  "apiAuthentication": {
    object (ApiAuthentication)
  },
  "serviceDirectoryConfig": {
    object (ServiceDirectoryConfig)
  },
  "tlsConfig": {
    object (TlsConfig)
  },
  "customHeaders": {
    string: string,
    ...
  },
  "toolOverrides": [
    {
      object (McpToolOverride)
    }
  ]
}
שדות
serverAddress

string

חובה. הכתובת של שרת ה-MCP, לדוגמה, https://example.com/mcp/. אם השרת נבנה באמצעות ה-SDK של MCP, צריך להוסיף את הסיומת ‎/mcp/‎ לכתובת ה-URL. יש תמיכה רק בשרתים מבוססי-תעבורה של HTTP שניתן להזרים מהם. מידע נוסף זמין בכתובת https://modelcontextprotocol.io/specification/2025-03-26/basic/transports#streamable-http.
apiAuthentication

object (ApiAuthentication)

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

object (ServiceDirectoryConfig)

זה שינוי אופציונלי. הגדרת Service Directory ל-VPC-SC, שמשמשת לפתרון שמות שירותים בתוך perimeter.
tlsConfig

object (TlsConfig)

זה שינוי אופציונלי. הגדרת TLS. כולל את אישורי השרת המותאמים אישית שהלקוח צריך לסמוך עליהם.
customHeaders

map (key: string, value: string)

זה שינוי אופציונלי. הכותרות המותאמות אישית שיישלחו בבקשה לשרת ה-MCP. הערכים צריכים להיות בפורמט $context.variables.<name_of_variable> ואפשר להגדיר אותם במשתני הסשן. פרטים נוספים זמינים בכתובת https://docs.cloud.google.com/customer-engagement-ai/conversational-agents/ps/tool/open-api#openapi-injection.

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

object (McpToolOverride)

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

McpToolOverride

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

ייצוג ב-JSON 
{
  "tool": string,
  "nameOverride": string,
  "descriptionOverride": string,
  "snapshot": {
    object (McpToolDefinition)
  }
}
שדות
tool

string

חובה. השם המקורי של הכלי כפי שהוא מועבר על ידי שרת ה-MCP.
nameOverride

string

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

string

זה שינוי אופציונלי. אם התיאור הזה קיים, הכלי משתמש בו במקום בתיאור המקורי מהשרת.
snapshot

object (McpToolDefinition)

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

McpToolDefinition

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

ייצוג ב-JSON 
{
  "description": string,
  "inputSchema": {
    object (Schema)
  },
  "outputSchema": {
    object (Schema)
  }
}
שדות
description

string

פלט בלבד. תיאור הכלי MCP. אפשר לשנות את ההגדרה הזו ב-descriptionOverride דרך McpToolOverride.
inputSchema

object (Schema)

פלט בלבד. הסכימה של ארגומנטי הקלט של כלי ה-MCP.
outputSchema

object (Schema)

פלט בלבד. הסכימה של ארגומנטי הפלט של כלי ה-MCP.

OpenApiToolset

ערכת כלים שמכילה רשימה של כלים שמוגדרים על ידי סכימת OpenAPI.

ייצוג ב-JSON 
{
  "openApiSchema": string,
  "apiAuthentication": {
    object (ApiAuthentication)
  },
  "tlsConfig": {
    object (TlsConfig)
  },
  "serviceDirectoryConfig": {
    object (ServiceDirectoryConfig)
  },
  "ignoreUnknownFields": boolean,
  "url": string
}
שדות
openApiSchema

string

חובה. סכימת OpenAPI של ערכת הכלים.
apiAuthentication

object (ApiAuthentication)

זה שינוי אופציונלי. פרטי האימות שנדרשים על ידי ה-API.
tlsConfig

object (TlsConfig)

זה שינוי אופציונלי. הגדרת TLS. כולל את אישורי השרת בהתאמה אישית
serviceDirectoryConfig

object (ServiceDirectoryConfig)

זה שינוי אופציונלי. הגדרת ספריית השירותים.
ignoreUnknownFields

boolean

זה שינוי אופציונלי. אם הערך הוא true, הסוכן יתעלם משדות לא ידועים בתגובת ה-API לכל הפעולות שמוגדרות בסכימת OpenAPI.
url

string

זה שינוי אופציונלי. כתובת ה-URL של השרת של סכימת Open API. השדה הזה מוגדר רק בערכות כלים בתלות הסביבתית במהלך תהליך הייצוא, אם הסכימה מכילה כתובת URL של שרת. במהלך תהליך הייבוא, אם כתובת ה-URL הזו מופיעה בתלות בסביבה ולסכימה יש פלייסהולדר מסוג ‎ $env_var, הפלייסהולדר יוחלף בסכימה.

ConnectorToolset

ערכת כלים שיוצרת כלים מחיבור Integration Connectors.

ייצוג ב-JSON 
{
  "connection": string,
  "authConfig": {
    object (EndUserAuthConfig)
  },
  "connectorActions": [
    {
      object (Action)
    }
  ]
}
שדות
connection

string

חובה. השם המלא של המשאב של חיבור Integration Connectors שאליו מתייחסים. פורמט: projects/{project}/locations/{location}/connections/{connection}
authConfig

object (EndUserAuthConfig)

זה שינוי אופציונלי. ההגדרה הזו קובעת איך מתבצע אימות ב-Integration Connectors. כברירת מחדל, אימות אדמין מועבר בבקשות Integration Connectors API. אפשר לשנות את ההגדרה הזו באמצעות הגדרת אימות אחרת של משתמשי קצה. הערה: כדי לציין כאן הגדרת EUC, צריך להפעיל את האפשרות 'ביטול הגדרות אימות' בחיבור – אחרת, יצירת ערכת הכלים תיכשל. מידע נוסף זמין בכתובת: https://cloud.google.com/application-integration/docs/configure-connectors-task#configure-authentication-override
connectorActions[]

object (Action)

חובה. רשימה של פעולות מחבר או פעולות ישות ליצירת כלים עבורן.

Methods

create

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

delete

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

get

 הפעולה מחזירה את הפרטים של ערכת הכלים שצוינה.

list

 רשימת ערכות הכלים באפליקציה הנתונה.

patch

 עדכון של ערכת הכלים שצוינה.

retrieveTools

 אחזור רשימת הכלים שנכללים בערכת הכלים שצוינה.