Skema metadata yang diperluas

App Hub otomatis menambahkan metadata yang diperluas ke beberapa layanan dan workload untuk meningkatkan visibilitas, tata kelola, dan integrasi dengan sistem lain. Kunci unik mengidentifikasi setiap skema yang didukung dan menentukan struktur serta kolom untuk jenis metadata tertentu. Untuk melihat metadata ini, lihat Melihat skema metadata yang diperluas.

apphub.googleapis.com/AgentProperties

Skema ini digunakan untuk mendeskripsikan properti agen AI, sehingga sistem lain dapat menemukan dan memahaminya. Biasanya, ini diterapkan ke workload yang memiliki properti jenis fungsional AGENT. Skema ini kompatibel dengan Kartu Agen Agent2Agent (A2A).

Definisi skema

Berikut adalah skema untuk jenis metadata ini dalam format JSON.

{
  "$schema": "http://json-schema.org/draft-07/schema#",
  "title": "apphub.googleapis.com/AgentProperties",
  "description": "The schema for apphub.googleapis.com/AgentProperties. Except for framework, the properties are derived from the A2A Agent Card.",
  "type": "object",
  "additionalProperties": false,
  "properties": {
    "displayName": {
      "type": "string",
      "description": "The display name of the agent."
    },
    "description": {
      "type": "string",
      "description": "The description of the agent."
    },
    "version": {
      "type": "string",
      "description": "Contains the version of the Agent."
    },
    "framework": {
      "type": "string",
      "description": "The agent framework used to develop the agent."
    },
    "agentCardUri": {
      "type": "string",
      "description": "The URI of the agent card for the agent."
    },
    "skills": {
      "type": "array",
      "description": "A list of skills the agent possesses.",
      "items": {
        "type": "object",
        "title": "Skills",
        "description": "Defines a skill for an agent.",
        "additionalProperties": false,
        "properties": {
          "id": {
            "type": "string",
            "description": "A unique identifier for the agent's skill."
          },
          "name": {
            "type": "string",
            "description": "A human readable name for the agent's skill."
          },
          "description": {
            "type": "string",
            "description": "A description of the agent's skill."
          },
          "tags": {
            "type": "array",
            "description": "A set of keywords describing the skill's capabilities.",
            "items": {
              "type": "string"
            }
          },
          "examples": {
            "type": "array",
            "description": "Example prompts or scenarios that this skill can handle.",
            "items": {
              "type": "string"
            }
          }
        }
      }
    }
  }
}

Deskripsi kolom

Kolom Jenis Deskripsi
displayName string Nama tampilan agen.
description string Deskripsi agen.
version string Versi agen.
framework string Framework yang digunakan untuk mengembangkan agen.
agentCardUri string URI kartu agen untuk agen.
skills array Daftar keahlian yang dimiliki agen.
skills.id string ID unik untuk keterampilan agen.
skills.name string Nama yang dapat dibaca manusia untuk keterampilan agen.
skills.description string Deskripsi keahlian agen.
skills.tags array dari string Serangkaian kata kunci yang menjelaskan kemampuan keahlian.
skills.examples array dari string Contoh perintah atau skenario yang dapat ditangani oleh keterampilan ini.

apphub.googleapis.com/McpServer

Skema apphub.googleapis.com/McpServer menentukan properti server Model Context Protocol (MCP) dan alat yang dieksposnya. App Hub menerapkan skema ini ke layanan yang memiliki properti jenis fungsional MCP_SERVER. Skema ini mencakup deklarasi endpoint transport dan definisi alat yang sesuai dengan spesifikasi MCP, termasuk petunjuk perilaku di annotations dan petunjuk kebijakan di _meta.

Definisi skema

Berikut adalah skema untuk jenis metadata ini dalam format JSON.

{
  "$schema": "http://json-schema.org/draft-07/schema#",
  "title": "apphub.googleapis.com/McpServer",
  "description": "The schema for apphub.googleapis.com/McpServer.",
  "type": "object",
  "additionalProperties": false,
  "properties": {
    "displayName": {
      "type": "string",
      "description": "The display name of the MCP Server."
    },
    "description": {
      "type": "string",
      "description": "The description of the MCP Server."
    },
    "interfaces": {
      "type": "array",
      "description": "The connection details for the MCP Server.",
      "items": {
        "$ref": "#/definitions/Interface"
      }
    },
    "tools": {
      "type": "array",
      "description": "Tools provided by the MCP Server.",
      "items": {
        "$ref": "#/definitions/Tool"
      }
    }
  },
  "required": ["interfaces"],
  "definitions": {
    "Tool": {
      "description": "Represents a single tool provided by an MCP Server.",
      "type": "object",
      "additionalProperties": false,
      "properties": {
        "name": {
          "type": "string",
          "description": "Human-readable name of the tool."
        },
        "description": {
          "type": "string",
          "description": "Description of what the tool does."
        },
        "annotations": {
          "$ref": "#/definitions/Tool.Annotations",
          "description": "Annotations associated with the tool."
        },
        "_meta": {
          "$ref": "#/definitions/Tool.Meta",
          "description": "Protocol-level metadata conforming to MCP _meta."
        }
      }
    },
    "Tool.Annotations": {
      "description": "Annotations describing the characteristics and behavior of a tool or operation.",
      "type": "object",
      "additionalProperties": false,
      "properties": {
        "title": {
          "type": "string",
          "description": "A human-readable title or name for the tool or operation."
        },
        "destructiveHint": {
          "type": "boolean",
          "description": "Hint indicating if the operation can cause destructive changes."
        },
        "idempotentHint": {
          "type": "boolean",
          "description": "Hint indicating if the operation is idempotent (safe to retry)."
        },
        "openWorldHint": {
          "type": "boolean",
          "description": "Hint indicating if the operation assumes an open world."
        },
        "readOnlyHint": {
          "type": "boolean",
          "description": "Hint indicating if the operation is read-only."
        }
      }
    },
    "Tool.Meta": {
      "type": "object",
      "description": "Protocol-level tool metadata container conforming to MCP _meta.",
      "additionalProperties": false,
      "properties": {
        "com.googleapis.iap/PolicyHints": {
          "$ref": "#/definitions/Iap.PolicyHints",
          "description": "IAP specific policy hints."
        }
      }
    },
    "Iap.PolicyHints": {
      "type": "object",
      "description": "IAP custom extensions to MCP policy hints.",
      "additionalProperties": false,
      "properties": {
        "authorization": {
          "$ref": "#/definitions/Iap.Authorization",
          "description": "Authorization configurations for the tool."
        }
      }
    },
    "Iap.Authorization": {
      "type": "object",
      "description": "Authorization configuration including Human-in-the-loop (HITL) settings.",
      "additionalProperties": false,
      "properties": {
        "toolDisabled": {
          "type": "boolean",
          "description": "Indicates if the tool is disabled. Defaults to false when absent, which means the tool is enabled."
        },
        "hitlMode": {
          "type": "string",
          "description": "Human-in-the-loop (HITL) execution mode.",
          "enum": [
            "HITL_MODE_UNSPECIFIED",
            "HITL_MODE_DISABLED",
            "HITL_MODE_ALWAYS",
            "HITL_MODE_IF_UNSAFE"
          ]
        }
      }
    },
    "Interface": {
      "description": "Represents interface.",
      "type": "object",
      "additionalProperties": false,
      "properties": {
        "url": {
          "type": "string",
          "description": "The destination URL.",
          "pattern": "^https?://"
        },
        "protocolBinding": {
          "type": "string",
          "description": "The protocol binding of the interface.",
          "enum": [
            "JSONRPC"
          ]
        }
      },
      "required": ["url", "protocolBinding"]
    }
  }
}

Deskripsi kolom

Kolom Jenis Deskripsi
displayName string Nama tampilan server MCP.
description string Deskripsi server MCP.
interfaces array Detail koneksi untuk server MCP.
interfaces.url string URL endpoint tujuan untuk antarmuka.
interfaces.protocolBinding string Binding protokol antarmuka, misalnya, JSONRPC.
tools array Alat yang disediakan oleh server MCP.
tools.name string Nama alat yang dapat dibaca manusia.
tools.description string Deskripsi tentang fungsi alat.
tools.annotations object Anotasi MCP standar yang terkait dengan alat.
tools.annotations.title string Judul yang dapat dibaca manusia untuk alat.
tools.annotations.readOnlyHint boolean Petunjuk yang menunjukkan apakah alat hanya mengambil data dan tidak mengubah lingkungannya.
tools.annotations.destructiveHint boolean Petunjuk yang menunjukkan apakah operasi dapat menyebabkan perubahan yang merusak.
tools.annotations.idempotentHint boolean Petunjuk yang menunjukkan apakah operasi bersifat idempoten dan aman untuk dicoba ulang.
tools.annotations.openWorldHint boolean Petunjuk yang menunjukkan apakah operasi berinteraksi dengan sistem eksternal.
tools._meta object Metadata tingkat protokol yang sesuai dengan spesifikasi _meta MCP. Kunci harus mengikuti notasi domain terbalik.
tools._meta.com.googleapis.iap/PolicyHints object Petunjuk kebijakan Identity-Aware Proxy (IAP) untuk alat ini.
tools._meta.com.googleapis.iap/PolicyHints.authorization object Konfigurasi otorisasi dan human-in-the-loop (HITL) untuk alat.
tools._meta.com.googleapis.iap/PolicyHints.authorization.toolDisabled boolean Menunjukkan apakah alat dinonaktifkan untuk pemanggilan. Tetapkan ke true untuk menonaktifkan alat. Nilai defaultnya adalah false jika dihilangkan, yang berarti alat diaktifkan.
tools._meta.com.googleapis.iap/PolicyHints.authorization.hitlMode string Mode eksekusi human-in-the-loop (HITL). Nilai yang didukung adalah HITL_MODE_UNSPECIFIED, HITL_MODE_DISABLED, HITL_MODE_ALWAYS, dan HITL_MODE_IF_UNSAFE.

discoveryengine.googleapis.com/agentregistry/connector

Skema discoveryengine.googleapis.com/agentregistry/connector menentukan metadata penyedia untuk konektor data Gemini Enterprise. Saat Anda mendaftarkan server Model Context Protocol (MCP) eksternal melalui konektor Gemini Enterprise, App Hub akan melampirkan metadata yang diperluas ini ke resource layanan yang mendasarinya.

Agent Registry menampilkan metadata ini di peta attributes dari resource penemuan McpServer yang sesuai sehingga aplikasi klien dan agen orchestrator dapat memeriksa properti konektor seperti type, state, dan instanceUri.

Definisi skema

Berikut adalah skema untuk jenis metadata ini dalam format JSON.

{
  "$schema": "http://json-schema.org/draft-07/schema#",
  "title": "discoveryengine.googleapis.com/agentregistry/connector",
  "description": "Gemini Enterprise (Discovery Engine) connector metadata. Present on the McpServer of a resource backed by a Gemini Enterprise connector. Every field is optional.",
  "type": "object",
  "additionalProperties": false,
  "properties": {
    "type": {
      "type": "string",
      "description": "The type of the Gemini Enterprise connector, as a lowercase hyphen-separated identifier: for example 'github', 'atlassian-rovo'. Instances of the same connector share a type; it identifies which external service the connector integrates with.",
      "maxLength": 128
    },
    "version": {
      "type": "string",
      "description": "The version of the connector definition this instance was created from, for example '1.0'.",
      "maxLength": 32
    },
    "state": {
      "type": "string",
      "description": "The provisioning state of the connector instance. Some possible values are: 'STATE_UNSPECIFIED', 'INITIALIZING', 'INITIALIZED', 'INITIALIZATION_FAILED', 'ACTIVE', 'RUNNING', 'FAILED', 'WARNING', 'UPDATING' or 'DELETING'.",
      "maxLength": 64
    },
    "instanceUri": {
      "type": "string",
      "description": "The customer's own site, for connectors addressed per customer: for example 'https://acme.atlassian.net'. This is the tenant the connector reads from, and differs from the MCP endpoint in 'interfaces', which is the same for every customer of a given connector. Absent for connectors that address a single fixed endpoint.",
      "maxLength": 512
    },
    "tenantId": {
      "type": "string",
      "description": "The identifier of the customer tenant within the external service, where the service requires one to address it.",
      "maxLength": 128
    },
    "skills": {
      "type": "array",
      "description": "The Agent Registry skill revisions a Gemini Enterprise administrator added to this custom MCP connector, one entry per skill, at most five. Absent for other connectors and for custom MCP connectors without any.",
      "maxItems": 5,
      "items": {
        "type": "object",
        "additionalProperties": false,
        "properties": {
          "skill": {
            "type": "string",
            "description": "The resource name of the skill, in the form 'projects/{project_number}/locations/{location}/skills/{skill}'.",
            "minLength": 1,
            "maxLength": 1024
          },
          "skillUid": {
            "type": "string",
            "description": "The 'uid' of the skill.",
            "minLength": 1,
            "maxLength": 128
          },
          "revision": {
            "type": "string",
            "description": "The resource name of the skill revision, in the form 'projects/{project_number}/locations/{location}/skills/{skill}/revisions/{revision}'.",
            "minLength": 1,
            "maxLength": 1024
          },
          "revisionUid": {
            "type": "string",
            "description": "The 'uid' of the skill revision.",
            "minLength": 1,
            "maxLength": 128
          },
          "sha256": {
            "type": "string",
            "description": "The SHA-256 digest of the skill revision's payload, as 64 lowercase hexadecimal characters.",
            "pattern": "^[0-9a-f]{64}$"
          }
        },
        "required": ["skill", "skillUid", "revision", "revisionUid", "sha256"]
      }
    }
  }
}

Deskripsi kolom

Kolom Jenis Deskripsi
type string Jenis konektor Gemini Enterprise sebagai ID yang dipisahkan tanda hubung dalam huruf kecil.
version string Versi definisi konektor yang digunakan untuk membuat instance ini.
state string Status penyediaan instance konektor.
instanceUri string URL situs pelanggan untuk konektor yang ditujukan per tenant.
tenantId string ID tenant pelanggan dalam layanan eksternal.
skills array Revisi keahlian Agent Registry yang dilampirkan ke konektor MCP kustom, hingga lima entri. Dihilangkan untuk konektor lain dan untuk konektor MCP kustom tanpa keahlian yang disertakan.
skills.skill string Nama resource keterampilan, dalam format projects/PROJECT_NUMBER/locations/LOCATION/skills/SKILL.
skills.skillUid string ID unik (uid) skill.
skills.revision string Nama resource revisi skill, dalam format projects/PROJECT_NUMBER/locations/LOCATION/skills/SKILL/revisions/REVISION.
skills.revisionUid string ID unik (uid) revisi skill.
skills.sha256 string Ringkasan SHA-256 dari payload revisi keahlian sebagai 64 karakter heksadesimal huruf kecil.