MCP Tools Reference: developerconnect.googleapis.com

Tool: create-connection

Erstellt eine neue Verbindung in einem bestimmten Projekt und an einem bestimmten Standort.

Das folgende Codebeispiel zeigt, wie Sie mit curl das MCP-Tool create-connection aufrufen.

Curl-Anfrage
curl --location 'https://developerconnect.googleapis.com/mcp' \
--header 'content-type: application/json' \
--header 'accept: application/json, text/event-stream' \
--data '{
  "method": "tools/call",
  "params": {
    "name": "create-connection",
    "arguments": {
      // Provide these details according to the MCP tool specification.
    }
  },
  "jsonrpc": "2.0",
  "id": 1
}'

Eingabeschema

Nachricht zum Erstellen einer Verbindung

CreateConnectionRequest

JSON-Darstellung
{
  "parent": string,
  "connectionId": string,
  "connection": {
    object (Connection)
  },
  "requestId": string,
  "validateOnly": boolean
}
Felder
parent

string

Pflichtangabe. Wert für das übergeordnete Element.

connectionId

string

Pflichtangabe. Die für die Verbindung zu verwendende ID, die die letzte Komponente des Ressourcennamens der Verbindung wird.

connection

object (Connection)

Pflichtangabe. Die Ressource, die erstellt wird

requestId

string

Optional. Eine optionale Anfrage-ID zur Identifizierung von Anfragen. Geben Sie eine eindeutige Anfrage-ID an, damit der Server die Anfrage ignoriert, falls sie bereits abgeschlossen wurde und wiederholt wird. Der Server gewährleistet dies für mindestens 60 Minuten nach der ersten Anfrage.

Nehmen wir an, Sie senden eine erste Anfrage, deren Zeitlimit überschritten wird. Wenn Sie die Anfrage mit derselben Anfrage-ID erneut senden, kann der Server prüfen, ob der ursprüngliche Vorgang mit derselben Anfrage-ID empfangen wurde. Ist dies der Fall, wird die zweite Anfrage ignoriert. So wird verhindert, dass Clients versehentlich doppelte Zusicherungen erstellen.

Die Anfrage-ID muss eine gültige UUID sein, mit der Ausnahme, dass UUIDs mit Nullen nicht unterstützt werden (00000000-0000-0000-0000-000000000000).

validateOnly

boolean

Optional. Wenn festgelegt, wird die Anfrage validiert, aber nicht tatsächlich gepostet.

Verbindung

JSON-Darstellung
{
  "name": string,
  "createTime": string,
  "updateTime": string,
  "deleteTime": string,
  "labels": {
    string: string,
    ...
  },
  "installationState": {
    object (InstallationState)
  },
  "disabled": boolean,
  "reconciling": boolean,
  "annotations": {
    string: string,
    ...
  },
  "etag": string,
  "uid": string,
  "cryptoKeyConfig": {
    object (CryptoKeyConfig)
  },
  "gitProxyConfig": {
    object (GitProxyConfig)
  },

  // Union field connection_config can be only one of the following:
  "githubConfig": {
    object (GitHubConfig)
  },
  "githubEnterpriseConfig": {
    object (GitHubEnterpriseConfig)
  },
  "gitlabConfig": {
    object (GitLabConfig)
  },
  "gitlabEnterpriseConfig": {
    object (GitLabEnterpriseConfig)
  },
  "bitbucketDataCenterConfig": {
    object (BitbucketDataCenterConfig)
  },
  "bitbucketCloudConfig": {
    object (BitbucketCloudConfig)
  },
  "secureSourceManagerInstanceConfig": {
    object (SecureSourceManagerInstanceConfig)
  },
  "httpConfig": {
    object (GenericHTTPEndpointConfig)
  }
  // End of list of possible types for union field connection_config.
}
Felder
name

string

ID. Der Ressourcenname der Verbindung im Format projects/{project}/locations/{location}/connections/{connection_id}.

createTime

string (Timestamp format)

Nur Ausgabe. Zeitstempel der Erstellung.

Verwendet RFC 3339, wobei die generierte Ausgabe immer Z-normalisiert ist und 0, 3, 6 oder 9 Nachkommastellen verwendet. Andere Offsets als „Z“ werden ebenfalls akzeptiert. Beispiele: "2014-10-02T15:01:23Z", "2014-10-02T15:01:23.045123456Z" oder "2014-10-02T15:01:23+05:30"

updateTime

string (Timestamp format)

Nur Ausgabe. Zeitstempel der Aktualisierung.

Verwendet RFC 3339, wobei die generierte Ausgabe immer Z-normalisiert ist und 0, 3, 6 oder 9 Nachkommastellen verwendet. Andere Offsets als „Z“ werden ebenfalls akzeptiert. Beispiele: "2014-10-02T15:01:23Z", "2014-10-02T15:01:23.045123456Z" oder "2014-10-02T15:01:23+05:30"

deleteTime

string (Timestamp format)

Nur Ausgabe. Zeitstempel löschen.

Verwendet RFC 3339, wobei die generierte Ausgabe immer Z-normalisiert ist und 0, 3, 6 oder 9 Nachkommastellen verwendet. Andere Offsets als „Z“ werden ebenfalls akzeptiert. Beispiele: "2014-10-02T15:01:23Z", "2014-10-02T15:01:23.045123456Z" oder "2014-10-02T15:01:23+05:30".

labels

map (key: string, value: string)

Optional. Labels als Schlüssel/Wert-Paare.

Ein Objekt, das eine Liste von "key": value-Paaren enthält. Beispiel: { "name": "wrench", "mass": "1.3kg", "count": "3" }.

installationState

object (InstallationState)

Nur Ausgabe. Installationsstatus der Verbindung.

disabled

boolean

Optional. Wenn „disabled“ auf „true“ gesetzt ist, ist die Funktion für diese Verbindung deaktiviert. Repository-basierte API-Methoden und die Webhook-Verarbeitung für Repositories in dieser Verbindung werden deaktiviert.

reconciling

boolean

Nur Ausgabe. Wird auf „true“ gesetzt, wenn die Verbindung im Hintergrund eingerichtet oder aktualisiert wird.

annotations

map (key: string, value: string)

Optional. Ermöglicht Clients, kleine Mengen beliebiger Daten zu speichern.

Ein Objekt, das eine Liste von "key": value-Paaren enthält. Beispiel: { "name": "wrench", "mass": "1.3kg", "count": "3" }.

etag

string

Optional. Diese Prüfsumme wird vom Server anhand des Werts anderer Felder berechnet und kann bei Aktualisierungs- und Löschanfragen gesendet werden, um sicherzustellen, dass der Client vor dem Fortfahren einen aktuellen Wert hat.

uid

string

Nur Ausgabe. Eine vom System zugewiesene eindeutige Kennung für die Verbindung.

cryptoKeyConfig

object (CryptoKeyConfig)

Optional. Die Konfiguration des kryptografischen Schlüssels. Dieses Feld wird von der Funktion „Kundenverwaltete Verschlüsselungsschlüssel“ (CMEK) verwendet.

gitProxyConfig

object (GitProxyConfig)

Optional. Konfiguration für die Git-Proxy-Funktion. Wenn Sie den Git-Proxy aktivieren, können Clients Git-Vorgänge für die in der Verbindung verknüpften Repositories ausführen. Weitere Informationen

Union-Feld connection_config. Konfiguration für die Verbindung, je nach Typ des Anbieters. Für connection_config ist nur einer der folgenden Werte zulässig:
githubConfig

object (GitHubConfig)

Konfiguration für Verbindungen zu github.com.

githubEnterpriseConfig

object (GitHubEnterpriseConfig)

Konfiguration für Verbindungen zu einer GitHub Enterprise-Instanz.

gitlabConfig

object (GitLabConfig)

Konfiguration für Verbindungen zu gitlab.com.

gitlabEnterpriseConfig

object (GitLabEnterpriseConfig)

Konfiguration für Verbindungen zu einer GitLab Enterprise-Instanz.

bitbucketDataCenterConfig

object (BitbucketDataCenterConfig)

Konfiguration für Verbindungen zu einer Instanz von Bitbucket Data Center.

bitbucketCloudConfig

object (BitbucketCloudConfig)

Konfiguration für Verbindungen zu einer Instanz von Bitbucket Cloud.

secureSourceManagerInstanceConfig

object (SecureSourceManagerInstanceConfig)

Konfiguration für Verbindungen zu einer Instanz von Secure Source Manager.

httpConfig

object (GenericHTTPEndpointConfig)

Optional. Konfiguration für Verbindungen zu einem HTTP-Dienstanbieter.

GitHubConfig

JSON-Darstellung
{
  "githubApp": enum (GitHubApp),
  "authorizerCredential": {
    object (OAuthCredential)
  },
  "appInstallationId": string,
  "installationUri": string
}
Felder
githubApp

enum (GitHubApp)

Erforderlich. Nicht veränderbar. Die GitHub-Anwendung, die für den GitHub-Nutzer oder die GitHub-Organisation installiert wurde.

authorizerCredential

object (OAuthCredential)

Optional. OAuth-Anmeldedaten des Kontos, das die GitHub-Anwendung autorisiert hat. Es wird empfohlen, ein Roboterkonto anstelle eines menschlichen Nutzerkontos zu verwenden. Das OAuth-Token muss mit der GitHub-Anwendung dieser Konfiguration verknüpft sein.

appInstallationId

string (int64 format)

Optional. Installations-ID der GitHub-Anwendung.

installationUri

string

Nur Ausgabe. Der URI, zu dem Sie navigieren müssen, um die mit dieser GitHubConfig verknüpfte Installation zu verwalten.

OAuthCredential

JSON-Darstellung
{
  "oauthTokenSecretVersion": string,
  "username": string
}
Felder
oauthTokenSecretVersion

string

Pflichtangabe. Eine SecretManager-Ressource, die das OAuth-Token enthält, das die Verbindung autorisiert. Format: projects/*/secrets/*/versions/* oder projects/*/locations/*/secrets/*/versions/* (wenn regionale Secrets an diesem Standort unterstützt werden).

username

string

Nur Ausgabe. Der mit diesem Token verknüpfte Nutzername.

GitHubEnterpriseConfig

JSON-Darstellung
{
  "hostUri": string,
  "appId": string,
  "appSlug": string,
  "privateKeySecretVersion": string,
  "webhookSecretSecretVersion": string,
  "appInstallationId": string,
  "installationUri": string,
  "serviceDirectoryConfig": {
    object (ServiceDirectoryConfig)
  },
  "serverVersion": string,
  "sslCaCertificate": string,
  "organization": string
}
Felder
hostUri

string

Pflichtangabe. Der URI des GitHub Enterprise-Hosts, für den diese Verbindung bestimmt ist.

appId

string (int64 format)

Optional. ID der GitHub-Anwendung, die aus dem Manifest erstellt wurde.

appSlug

string

Nur Ausgabe. Der URL-freundliche Name der GitHub-Anwendung.

privateKeySecretVersion

string

Optional. SecretManager-Ressource, die den privaten Schlüssel der GitHub-Anwendung enthält, formatiert als projects/*/secrets/*/versions/* oder projects/*/locations/*/secrets/*/versions/* (wenn regionale Secrets an diesem Standort unterstützt werden).

webhookSecretSecretVersion

string

Optional. SecretManager-Ressource, die das Webhook-Secret der GitHub-Anwendung enthält, formatiert als projects/*/secrets/*/versions/* oder projects/*/locations/*/secrets/*/versions/* (wenn regionale Secrets an diesem Standort unterstützt werden).

appInstallationId

string (int64 format)

Optional. ID der Installation der GitHub-Anwendung.

installationUri

string

Nur Ausgabe. Der URI, zu dem Sie navigieren müssen, um die mit dieser GitHubEnterpriseConfig verknüpfte Installation zu verwalten.

serviceDirectoryConfig

object (ServiceDirectoryConfig)

Optional. Konfiguration für die Verwendung von Service Directory, um eine private Verbindung zu einem GitHub Enterprise-Server herzustellen. Dies sollte nur festgelegt werden, wenn der GitHub Enterprise-Server lokal gehostet wird und nicht über das öffentliche Internet erreichbar ist. Wenn dieses Feld leer bleibt, werden Aufrufe an den GitHub Enterprise-Server über das öffentliche Internet ausgeführt.

serverVersion

string

Nur Ausgabe. GitHub Enterprise-Version, die unter der host_uri installiert ist.

sslCaCertificate

string

Optional. SSL-Zertifikat, das für Anfragen an GitHub Enterprise verwendet werden soll.

organization

string

Optional. Nicht veränderbar. GitHub Enterprise-Organisation, in der die GitHub-Anwendung erstellt wird.

ServiceDirectoryConfig

JSON-Darstellung
{
  "service": string
}
Felder
service

string

Pflichtangabe. Der Name des Service Directory-Dienstes. Format: projects/{project}/locations/{location}/namespaces/{namespace}/services/{service}.

GitLabConfig

JSON-Darstellung
{
  "webhookSecretSecretVersion": string,
  "readAuthorizerCredential": {
    object (UserCredential)
  },
  "authorizerCredential": {
    object (UserCredential)
  }
}
Felder
webhookSecretSecretVersion

string

Erforderlich. Nicht veränderbar. SecretManager-Ressource, die das Webhook-Secret eines GitLab-Projekts enthält, formatiert als projects/*/secrets/*/versions/* oder projects/*/locations/*/secrets/*/versions/* (wenn regionale Secrets an diesem Standort unterstützt werden). Dieser wird zur Validierung von Webhooks verwendet.

readAuthorizerCredential

object (UserCredential)

Pflichtangabe. Ein persönliches GitLab-Zugriffstoken mit dem Mindestzugriffsbereich read_api und der Mindestrolle reporter. Die GitLab-Projekte, die für dieses persönliche Zugriffstoken sichtbar sind, bestimmen, auf welche Projekte Developer Connect Zugriff hat.

authorizerCredential

object (UserCredential)

Pflichtangabe. Ein persönliches GitLab-Zugriffstoken mit dem Mindestzugriffsbereich api und der Mindestrolle maintainer. Die GitLab-Projekte, die für dieses persönliche Zugriffstoken sichtbar sind, bestimmen, auf welche Projekte Developer Connect Zugriff hat.

UserCredential

JSON-Darstellung
{
  "userTokenSecretVersion": string,
  "username": string
}
Felder
userTokenSecretVersion

string

Pflichtangabe. Eine SecretManager-Ressource, die das Nutzertoken enthält, das die Developer Connect-Verbindung autorisiert. Format: projects/*/secrets/*/versions/* oder projects/*/locations/*/secrets/*/versions/* (wenn regionale Secrets an diesem Standort unterstützt werden).

username

string

Nur Ausgabe. Der mit diesem Token verknüpfte Nutzername.

GitLabEnterpriseConfig

JSON-Darstellung
{
  "hostUri": string,
  "webhookSecretSecretVersion": string,
  "readAuthorizerCredential": {
    object (UserCredential)
  },
  "authorizerCredential": {
    object (UserCredential)
  },
  "serviceDirectoryConfig": {
    object (ServiceDirectoryConfig)
  },
  "sslCaCertificate": string,
  "serverVersion": string
}
Felder
hostUri

string

Pflichtangabe. Der URI des GitLab Enterprise-Hosts, für den diese Verbindung bestimmt ist.

webhookSecretSecretVersion

string

Pflichtangabe. Nicht veränderbar. SecretManager-Ressource, die das Webhook-Secret eines GitLab-Projekts enthält, formatiert als projects/*/secrets/*/versions/* oder projects/*/locations/*/secrets/*/versions/* (wenn regionale Secrets an diesem Standort unterstützt werden). Dieser wird zur Validierung von Webhooks verwendet.

readAuthorizerCredential

object (UserCredential)

Pflichtangabe. Ein persönliches GitLab-Zugriffstoken mit dem Mindestzugriffsbereich read_api und der Mindestrolle reporter. Die GitLab-Projekte, die für dieses persönliche Zugriffstoken sichtbar sind, bestimmen, auf welche Projekte Developer Connect Zugriff hat.

authorizerCredential

object (UserCredential)

Pflichtangabe. Ein persönliches GitLab-Zugriffstoken mit dem Mindestzugriffsbereich api und der Mindestrolle maintainer. Die GitLab-Projekte, die für dieses persönliche Zugriffstoken sichtbar sind, bestimmen, auf welche Projekte Developer Connect Zugriff hat.

serviceDirectoryConfig

object (ServiceDirectoryConfig)

Optional. Konfiguration für die Verwendung von Service Directory, um eine private Verbindung zu einer GitLab Enterprise-Instanz herzustellen. Dies sollte nur festgelegt werden, wenn der GitLab Enterprise-Server lokal gehostet wird und nicht über das öffentliche Internet erreichbar ist. Wenn dieses Feld leer bleibt, werden Aufrufe an den GitLab Enterprise-Server über das öffentliche Internet gesendet.

sslCaCertificate

string

Optional. SSL-Zertifikat der Zertifizierungsstelle, das für Anfragen an die GitLab Enterprise-Instanz verwendet werden soll.

serverVersion

string

Nur Ausgabe. Version des GitLab Enterprise-Servers, der auf der host_uri ausgeführt wird.

BitbucketDataCenterConfig

JSON-Darstellung
{
  "hostUri": string,
  "webhookSecretSecretVersion": string,
  "readAuthorizerCredential": {
    object (UserCredential)
  },
  "authorizerCredential": {
    object (UserCredential)
  },
  "serviceDirectoryConfig": {
    object (ServiceDirectoryConfig)
  },
  "sslCaCertificate": string,
  "serverVersion": string
}
Felder
hostUri

string

Pflichtangabe. Der URI des Bitbucket Rechenzentrum-Hosts, für den diese Verbindung bestimmt ist.

webhookSecretSecretVersion

string

Pflichtangabe. Nicht veränderbar. SecretManager-Ressource, die das Webhook-Secret enthält, das zum Überprüfen von Webhook-Ereignissen verwendet wird. Formatiert als projects/*/secrets/*/versions/* oder projects/*/locations/*/secrets/*/versions/* (wenn regionale Secrets an diesem Standort unterstützt werden). Dieser wird zur Validierung von Webhooks verwendet.

readAuthorizerCredential

object (UserCredential)

Pflichtangabe. Ein HTTP-Zugriffstoken mit dem Mindestzugriff Repository read. Es wird empfohlen, ein Systemkonto zum Generieren der Anmeldedaten zu verwenden.

authorizerCredential

object (UserCredential)

Pflichtangabe. Ein HTTP-Zugriffstoken mit dem Mindestzugriffsbereich Repository admin. Dies ist zum Erstellen von Webhooks erforderlich. Es wird empfohlen, diese Anmeldedaten mit einem Systemkonto zu generieren.

serviceDirectoryConfig

object (ServiceDirectoryConfig)

Optional. Konfiguration für die Verwendung von Service Directory, um eine private Verbindung zu einer Bitbucket Data Center-Instanz herzustellen. Dies sollte nur festgelegt werden, wenn das Bitbucket-Rechenzentrum lokal gehostet wird und nicht über das öffentliche Internet erreichbar ist. Wenn dieses Feld leer bleibt, werden Aufrufe an das Bitbucket Data Center über das öffentliche Internet ausgeführt.

sslCaCertificate

string

Optional. SSL-Zertifizierungsstelle, der bei Anfragen an Bitbucket Data Center vertraut werden soll.

serverVersion

string

Nur Ausgabe. Version des Bitbucket Data Center-Servers, der auf der host_uri ausgeführt wird.

BitbucketCloudConfig

JSON-Darstellung
{
  "workspace": string,
  "webhookSecretSecretVersion": string,
  "readAuthorizerCredential": {
    object (UserCredential)
  },
  "authorizerCredential": {
    object (UserCredential)
  }
}
Felder
workspace

string

Pflichtangabe. Die Bitbucket Cloud-Workspace-ID, die mit der Google Cloud Platform verbunden werden soll.

webhookSecretSecretVersion

string

Pflichtangabe. Nicht veränderbar. SecretManager-Ressource, die das Webhook-Secret enthält, das zum Überprüfen von Webhook-Ereignissen verwendet wird. Formatiert als projects/*/secrets/*/versions/* oder projects/*/locations/*/secrets/*/versions/* (wenn regionale Secrets an diesem Standort unterstützt werden). Dieser wird zum Validieren und Erstellen von Webhooks verwendet.

readAuthorizerCredential

object (UserCredential)

Pflichtangabe. Ein Zugriffstoken mit dem Mindestzugriff repository. Es kann sich um ein Workspace-, Projekt- oder Repository-Zugriffstoken handeln. Es wird empfohlen, ein Systemkonto zum Generieren der Anmeldedaten zu verwenden.

authorizerCredential

object (UserCredential)

Pflichtangabe. Ein Zugriffstoken mit dem Mindestzugriffsbereich repository, pullrequest und webhook. Es kann sich um ein Workspace-, Projekt- oder Repository-Zugriffstoken handeln. Dies ist zum Erstellen von Webhooks erforderlich. Es wird empfohlen, diese Anmeldedaten mit einem Systemkonto zu generieren.

SecureSourceManagerInstanceConfig

JSON-Darstellung
{
  "instance": string
}
Felder
instance

string

Erforderlich. Nicht veränderbar. Secure Source Manager-Instanzressource, formatiert als projects/*/locations/*/instances/*

GenericHTTPEndpointConfig

JSON-Darstellung
{
  "hostUri": string,
  "serviceDirectoryConfig": {
    object (ServiceDirectoryConfig)
  },
  "sslCaCertificate": string,

  // Union field authentication can be only one of the following:
  "basicAuthentication": {
    object (BasicAuthentication)
  },
  "bearerTokenAuthentication": {
    object (BearerTokenAuthentication)
  }
  // End of list of possible types for union field authentication.
}
Felder
hostUri

string

Erforderlich. Nicht veränderbar. Der HTTPS-Endpunkt des Dienstanbieters.

serviceDirectoryConfig

object (ServiceDirectoryConfig)

Optional. Konfiguration für die Verwendung von Service Directory, um eine private Verbindung zu einem HTTP-Dienstanbieter herzustellen. Dies sollte nur festgelegt werden, wenn der HTTP-Dienstanbieter lokal gehostet wird und nicht über das öffentliche Internet erreichbar ist. Wenn dieses Feld leer bleibt, werden Aufrufe an den HTTP-Dienstanbieter über das öffentliche Internet gesendet.

sslCaCertificate

string

Optional. Das SSL-Zertifikat, das für Anfragen an den HTTP-Dienstanbieter verwendet werden soll.

Union-Feld authentication. Der Authentifizierungsmechanismus, der für Anfragen an den HTTP-Dienstanbieter verwendet werden soll. Für authentication ist nur einer der folgenden Werte zulässig:
basicAuthentication

object (BasicAuthentication)

Optional. Basisauthentifizierung mit Nutzername und Passwort.

bearerTokenAuthentication

object (BearerTokenAuthentication)

Optional. Inhabertoken-Authentifizierung mit einem Token.

BasicAuthentication

JSON-Darstellung
{
  "username": string,

  // Union field password can be only one of the following:
  "passwordSecretVersion": string
  // End of list of possible types for union field password.
}
Felder
username

string

Pflichtangabe. Der Nutzername, mit dem die Authentifizierung erfolgen soll.

Union-Feld password. Das Passwort für die Authentifizierung. Für password ist nur einer der folgenden Werte zulässig:
passwordSecretVersion

string

Die Secret Manager-Secret-Version des Passworts, mit dem die Authentifizierung erfolgen soll.

BearerTokenAuthentication

JSON-Darstellung
{

  // Union field token can be only one of the following:
  "tokenSecretVersion": string
  // End of list of possible types for union field token.
}
Felder
Union-Feld token. Das Token, mit dem die Authentifizierung erfolgen soll. Für token ist nur einer der folgenden Werte zulässig:
tokenSecretVersion

string

Optional. Die SecretManager-Secret-Version des Tokens, mit der die Authentifizierung erfolgen soll.

Zeitstempel

JSON-Darstellung
{
  "seconds": string,
  "nanos": integer
}
Felder
seconds

string (int64 format)

Stellt Sekunden der UTC-Zeit seit Unix-Epoche 1970-01-01T00:00:00Z dar. Muss zwischen -62135596800 und 253402300799 (einschließlich) liegen (entspricht 0001-01-01T00:00:00Z bis 9999-12-31T23:59:59Z).

nanos

integer

Nicht negative Sekundenbruchteile Nanosekunden-Auflösung. Dieses Feld ist der Nanosekunden-Teil der Dauer, keine Alternative zu Sekunden. Negative Sekundenwerte mit Bruchteilen müssen weiterhin nicht negative Nano-Werte haben, die zeitlich vorwärts gezählt werden. Muss zwischen 0 und 999.999.999 (einschließlich) liegen.

LabelsEntry

JSON-Darstellung
{
  "key": string,
  "value": string
}
Felder
key

string

value

string

InstallationState

JSON-Darstellung
{
  "stage": enum (Stage),
  "message": string,
  "actionUri": string
}
Felder
stage

enum (Stage)

Nur Ausgabe. Aktueller Schritt des Installationsprozesses.

message

string

Nur Ausgabe. Nachricht, was der Nutzer als Nächstes tun soll, um die Installation fortzusetzen. Leerer String, wenn die Installation bereits abgeschlossen ist.

actionUri

string

Nur Ausgabe. Link für die nächste Aktion. Leerer String, wenn die Installation bereits abgeschlossen ist.

AnnotationsEntry

JSON-Darstellung
{
  "key": string,
  "value": string
}
Felder
key

string

value

string

CryptoKeyConfig

JSON-Darstellung
{
  "keyReference": string
}
Felder
keyReference

string

Pflichtangabe. Der Name des Schlüssels, der zum Verschlüsseln/Entschlüsseln von Kundendaten verwendet wird. Der Schlüssel in Cloud KMS muss das Format projects/*/locations/*/keyRings/*/cryptoKeys/* haben.

GitProxyConfig

JSON-Darstellung
{
  "enabled": boolean,
  "httpProxyBaseUri": string
}
Felder
enabled

boolean

Optional. Wenn Sie diese Option auf „true“ setzen, kann der Git-Proxy für Git-Vorgänge in den mit der Verbindung verknüpften Repositories verwendet werden.

httpProxyBaseUri

string

Nur Ausgabe. Der Basis-URI für den HTTP-Proxy-Endpunkt. Hat das Format https://{generatedID}-c-h-{shortRegion}.developerconnect.dev. Wird nur ausgefüllt, wenn „enabled“ auf „true“ gesetzt ist. Dieser Endpunkt wird von anderen Google-Diensten verwendet, die in Developer Connect eingebunden sind.

GitHubApp

Stellt die verschiedenen GitHub-Anwendungen dar, die für einen GitHub-Nutzer oder eine GitHub-Organisation installiert und mit Developer Connect verwendet werden können.

Enums
GIT_HUB_APP_UNSPECIFIED GitHub-Anwendung nicht angegeben.
DEVELOPER_CONNECT Die Developer Connect GitHub-Anwendung.
FIREBASE Die Firebase GitHub-Anwendung.
GEMINI_CODE_ASSIST Die Gemini Code Assist-Anwendung.
DATAFORM Die Dataform-GitHub-Anwendung.

Phase

Phase des Installationsvorgangs.

Enums
STAGE_UNSPECIFIED Keine Phase angegeben.
PENDING_CREATE_APP Nur für GitHub Enterprise. Die Erstellung einer App wurde angefordert. Der Nutzer muss die Erstellung in seinem GitHub Enterprise-Host bestätigen.
PENDING_USER_OAUTH Der Nutzer muss die GitHub-Anwendung (oder Enterprise-Anwendung) über OAuth autorisieren.
PENDING_INSTALL_APP Der Nutzer muss dem Link folgen, um die GitHub-Anwendung (oder Enterprise-Anwendung) zu installieren.
COMPLETE Die Installation ist abgeschlossen.

Ausgabeschema

Diese Ressource steht für einen Vorgang mit langer Ausführungszeit, der das Ergebnis eines Netzwerk-API-Aufrufs ist.

Vorgang

JSON-Darstellung
{
  "name": string,
  "metadata": {
    "@type": string,
    field1: ...,
    ...
  },
  "done": boolean,

  // Union field result can be only one of the following:
  "error": {
    object (Status)
  },
  "response": {
    "@type": string,
    field1: ...,
    ...
  }
  // End of list of possible types for union field result.
}
Felder
name

string

Der vom Server zugewiesene Name, der nur innerhalb des Dienstes eindeutig ist, der ihn ursprünglich zurückgibt. Wenn Sie die Standard-HTTP-Zuordnung verwenden, sollte name ein Ressourcenname sein, der auf operations/{unique_id} endet.

metadata

object

Dienstspezifische Metadaten, die mit dem Vorgang verknüpft sind. Typischerweise enthalten sie Informationen zum Verlauf und gemeinsame Metadaten wie den Erstellungszeitpunkt. Solche Metadaten werden nicht von allen Diensten bereitgestellt. Jede Methode, die einen Vorgang mit langer Ausführungszeit zurückgibt, muss gegebenenfalls den Metadatentyp dokumentieren.

Ein Objekt, das Felder eines beliebigen Typs enthält. Ein zusätzliches Feld "@type" enthält einen URI zur Identifizierung des Typs. Beispiel: { "id": 1234, "@type": "types.example.com/standard/id" }

done

boolean

Ist der Wert false, bedeutet das, dass der Vorgang noch läuft. Ist der Wert hingegen true, ist der Vorgang abgeschlossen und entweder error oder response ist verfügbar.

Union-Feld result. Das Ergebnis des Vorgangs kann entweder ein error oder eine gültige response sein. Wenn done = false ist, wird weder error noch response festgelegt. Wenn done = true ist, kann genau ein error oder eine response festgelegt werden. Einige Dienste stellen das Ergebnis möglicherweise nicht bereit. Für result ist nur einer der folgenden Werte zulässig:
error

object (Status)

Das Fehlerergebnis des Vorgangs im Fall eines Fehlers oder Abbruchs.

response

object

Die normale, erfolgreiche Antwort des Vorgangs. Wenn die ursprüngliche Methode im Erfolgsfall keine Daten zurückgibt, wie bei Delete, lautet die Antwort google.protobuf.Empty. Ist die ursprüngliche Methode standardmäßig Get/Create/Update, sollte die Antwort die Ressource sein. Bei anderen Methoden sollte die Antwort vom Typ XxxResponse sein, wobei Xxx der Name der ursprünglichen Methode ist. Wenn zum Beispiel der Name der ursprünglichen Methode TakeSnapshot() ist, ist der gefolgerte Antworttyp TakeSnapshotResponse.

Ein Objekt, das Felder eines beliebigen Typs enthält. Ein zusätzliches Feld "@type" enthält einen URI zur Identifizierung des Typs. Beispiel: { "id": 1234, "@type": "types.example.com/standard/id" }.

Beliebig

JSON-Darstellung
{
  "typeUrl": string,
  "value": string
}
Felder
typeUrl

string

Gibt den Typ der serialisierten Protobuf-Nachricht mit einer URI-Referenz an, die aus einem Präfix, das mit einem Schrägstrich endet, und dem vollständig qualifizierten Typnamen besteht.

Beispiel: type.googleapis.com/google.protobuf.StringValue

Dieser String muss mindestens ein /-Zeichen enthalten und der Inhalt nach dem letzten / muss der vollständig qualifizierte Name des Typs in kanonischer Form ohne führenden Punkt sein. Geben Sie für diese URI-Referenzen kein Schema an, damit Clients nicht versuchen, sie zu kontaktieren.

Das Präfix ist beliebig und Protobuf-Implementierungen entfernen einfach alles bis einschließlich des letzten /, um den Typ zu identifizieren. type.googleapis.com/ ist ein gängiges Standardpräfix, das für einige Legacy-Implementierungen erforderlich ist. Dieses Präfix gibt nicht den Ursprung des Typs an und URIs, die es enthalten, reagieren voraussichtlich nicht auf Anfragen.

Alle Typ-URL-Strings müssen gültige URI-Referenzen sein. Für das Textformat gilt die zusätzliche Einschränkung, dass der Inhalt der Referenz nur aus alphanumerischen Zeichen, prozentcodierten Escapes und Zeichen aus dem folgenden Satz (ohne die äußeren Backticks) bestehen darf: /-.~_!$&()*+,;=. Obwohl wir die Prozentcodierung zulassen, sollten Implementierungen sie nicht entfernen, um Verwechslungen mit vorhandenen Parsern zu vermeiden. Beispielsweise sollte type.googleapis.com%2FFoo abgelehnt werden.

Im ursprünglichen Design von Any wurde die Möglichkeit in Betracht gezogen, einen Typauflösungsdienst unter diesen Typ-URLs zu starten. Protobuf hat jedoch nie einen solchen Dienst implementiert und betrachtet die Kontaktaufnahme mit diesen URLs als problematisch und als potenzielles Sicherheitsrisiko. Versuchen Sie nicht, URLs einzugeben.

value

string (bytes format)

Enthält eine Protobuf-Serialisierung des Typs, der durch „type_url“ beschrieben wird.

Ein base64-codierter String.

Status

JSON-Darstellung
{
  "code": integer,
  "message": string,
  "details": [
    {
      "@type": string,
      field1: ...,
      ...
    }
  ]
}
Felder
code

integer

Der Statuscode, der idealerweise ein ENUM-Wert von google.rpc.Code ist.

message

string

Eine an Entwickler gerichtete Fehlermeldung, die englischsprachig sein sollte. Jede für Nutzer sichtbare Fehlermeldung sollte lokalisiert und im Feld google.rpc.Status.details gesendet werden. Sie kann auch clientseitig lokalisiert werden.

details[]

object

Eine Auflistung aller Meldungen, die die Fehlerdetails enthalten. Es gibt einen gemeinsamen Satz von Nachrichtentypen, die APIs verwenden können.

Ein Objekt, das Felder eines beliebigen Typs enthält. Ein zusätzliches Feld "@type" enthält einen URI zur Identifizierung des Typs. Beispiel: { "id": 1234, "@type": "types.example.com/standard/id" }.

Tool-Annotationen

Tool-Anmerkungen werden an MCP-Clients gesendet, um das grundlegende Risiko eines bestimmten Tools zu beschreiben. Die meisten Clients behandeln diese Hinweise als nicht vertrauenswürdig, sie können aber verwendet werden, um zu entscheiden, wann eine Bestätigungsaufforderung an einen Nutzer gesendet werden soll.

Zusätzlich zum Titelstring werden die folgenden booleschen Hinweise definiert:

  • readOnlyHint: Wenn „true“, ändert das Tool seine Umgebung nicht. Standardeinstellung: false.
  • destructiveHint: Wenn „true“, kann das Tool destruktive Aktionen ausführen. Wenn „false“, kann das Tool nur additive Aktionen ausführen. Standardeinstellung: true.
  • idempotentHint: Wenn „true“, hat das wiederholte Aufrufen des Tools mit denselben Argumenten keine zusätzlichen Auswirkungen auf die Umgebung. Standardeinstellung: false.
  • openWorldHint: Wenn „true“, kann das Tool mit einer „offenen Welt“ externer Entitäten interagieren. Wenn „false“, kann das Tool nur mit internen Entitäten interagieren. Ein Tool für die Websuche wäre beispielsweise ein Open-World-Tool, ein Tool für gemerkte Informationen dagegen nicht.

Destruktiver Hinweis: ❌ | Idempotenter Hinweis: ❌ | Lesezugriff-Hinweis: ❌ | Open-World-Hinweis: ❌