MCP Tools Reference: developerconnect.googleapis.com

Alat: create-connection

Membuat Koneksi baru di project dan lokasi tertentu.

Contoh kode berikut menunjukkan cara menggunakan curl untuk memanggil alat MCP create-connection.

Permintaan Curl
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
}'

Skema Input

Pesan untuk membuat Koneksi

CreateConnectionRequest

Representasi JSON
{
  "parent": string,
  "connectionId": string,
  "connection": {
    object (Connection)
  },
  "requestId": string,
  "validateOnly": boolean
}
Kolom
parent

string

Wajib. Nilai untuk induk.

connectionId

string

Wajib. ID yang akan digunakan untuk koneksi, yang menjadi komponen akhir dari nama resource koneksi.

connection

object (Connection)

Wajib. Resource yang sedang dibuat

requestId

string

Opsional. ID permintaan opsional untuk mengidentifikasi permintaan. Tentukan ID permintaan unik sehingga jika Anda harus mencoba lagi permintaan, server akan tahu untuk mengabaikan permintaan jika sudah selesai. Server akan menjamin hal tersebut setidaknya selama 60 menit sejak permintaan pertama.

Misalnya, pertimbangkan situasi saat Anda membuat permintaan awal dan waktu permintaan habis. Jika Anda membuat permintaan lagi dengan ID permintaan yang sama, server dapat memeriksa apakah operasi asli dengan ID permintaan yang sama telah diterima, dan jika iya, akan mengabaikan permintaan kedua. Tindakan ini mencegah klien membuat komitmen duplikat secara tidak sengaja.

ID permintaan harus berupa UUID yang valid, kecuali UUID nol tidak didukung (00000000-0000-0000-0000-000000000000).

validateOnly

boolean

Opsional. Jika ditetapkan, validasi permintaan, tetapi jangan benar-benar mempostingnya.

Koneksi

Representasi JSON
{
  "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.
}
Kolom
name

string

ID. Nama resource koneksi, dalam format projects/{project}/locations/{location}/connections/{connection_id}.

createTime

string (Timestamp format)

Hanya output. Stempel waktu pembuatan.

Menggunakan RFC 3339 yang outputnya akan selalu dinormalisasi Z dan menggunakan 0, 3, 6, atau 9 digit pecahan. Offset selain "Z" juga diterima. Contoh: "2014-10-02T15:01:23Z", "2014-10-02T15:01:23.045123456Z", atau "2014-10-02T15:01:23+05:30".

updateTime

string (Timestamp format)

Hanya output. Memperbarui stempel waktu.

Menggunakan RFC 3339 yang outputnya akan selalu dinormalisasi Z dan menggunakan 0, 3, 6, atau 9 digit pecahan. Offset selain "Z" juga diterima. Contoh: "2014-10-02T15:01:23Z", "2014-10-02T15:01:23.045123456Z", atau "2014-10-02T15:01:23+05:30".

deleteTime

string (Timestamp format)

Hanya output. Hapus stempel waktu.

Menggunakan RFC 3339 yang outputnya akan selalu dinormalisasi Z dan menggunakan 0, 3, 6, atau 9 digit pecahan. Offset selain "Z" juga diterima. Contoh: "2014-10-02T15:01:23Z", "2014-10-02T15:01:23.045123456Z", atau "2014-10-02T15:01:23+05:30".

labels

map (key: string, value: string)

Opsional. Label sebagai key-value pair

Objek yang berisi daftar pasangan "key": value. Contoh: { "name": "wrench", "mass": "1.3kg", "count": "3" }.

installationState

object (InstallationState)

Hanya output. Status penginstalan Koneksi.

disabled

boolean

Opsional. Jika dinonaktifkan disetel ke benar (true), fungsi akan dinonaktifkan untuk koneksi ini. Metode API berbasis repositori dan pemrosesan webhook untuk repositori dalam koneksi ini akan dinonaktifkan.

reconciling

boolean

Hanya output. Tetapkan ke true saat koneksi sedang disiapkan atau diperbarui di latar belakang.

annotations

map (key: string, value: string)

Opsional. Memungkinkan klien menyimpan data arbitrer dalam jumlah kecil.

Objek yang berisi daftar pasangan "key": value. Contoh: { "name": "wrench", "mass": "1.3kg", "count": "3" }.

etag

string

Opsional. Checksum ini dihitung oleh server berdasarkan nilai kolom lain, dan dapat dikirim pada permintaan update dan penghapusan untuk memastikan klien memiliki nilai terbaru sebelum melanjutkan.

uid

string

Hanya output. ID unik yang ditetapkan sistem untuk Koneksi.

cryptoKeyConfig

object (CryptoKeyConfig)

Opsional. Konfigurasi kunci kripto. Kolom ini digunakan oleh fitur Kunci Enkripsi yang Dikelola Pelanggan (CMEK).

gitProxyConfig

object (GitProxyConfig)

Opsional. Konfigurasi untuk fitur proxy Git. Mengaktifkan proxy Git memungkinkan klien melakukan operasi Git pada repositori yang ditautkan dalam koneksi. Pelajari lebih lanjut.

Kolom union connection_config. Konfigurasi untuk koneksi bergantung pada jenis penyedia. connection_config hanya ada berupa salah satu diantara berikut:
githubConfig

object (GitHubConfig)

Konfigurasi untuk koneksi ke github.com.

githubEnterpriseConfig

object (GitHubEnterpriseConfig)

Konfigurasi untuk koneksi ke instance GitHub Enterprise.

gitlabConfig

object (GitLabConfig)

Konfigurasi untuk koneksi ke gitlab.com.

gitlabEnterpriseConfig

object (GitLabEnterpriseConfig)

Konfigurasi untuk koneksi ke instance GitLab Enterprise.

bitbucketDataCenterConfig

object (BitbucketDataCenterConfig)

Konfigurasi untuk koneksi ke instance Bitbucket Data Center.

bitbucketCloudConfig

object (BitbucketCloudConfig)

Konfigurasi untuk koneksi ke instance Bitbucket Cloud.

secureSourceManagerInstanceConfig

object (SecureSourceManagerInstanceConfig)

Konfigurasi untuk koneksi ke instance Secure Source Manager.

httpConfig

object (GenericHTTPEndpointConfig)

Opsional. Konfigurasi untuk koneksi ke penyedia layanan HTTP.

GitHubConfig

Representasi JSON
{
  "githubApp": enum (GitHubApp),
  "authorizerCredential": {
    object (OAuthCredential)
  },
  "appInstallationId": string,
  "installationUri": string
}
Kolom
githubApp

enum (GitHubApp)

Wajib. Tidak dapat diubah. Aplikasi GitHub yang diinstal ke pengguna atau organisasi GitHub.

authorizerCredential

object (OAuthCredential)

Opsional. Kredensial OAuth akun yang mengizinkan Aplikasi GitHub. Sebaiknya gunakan akun robot, bukan akun pengguna manusia. Token OAuth harus terkait dengan Aplikasi GitHub dari konfigurasi ini.

appInstallationId

string (int64 format)

Opsional. ID penginstalan Aplikasi GitHub.

installationUri

string

Hanya output. URI yang akan dibuka untuk mengelola penginstalan yang terkait dengan GitHubConfig ini.

OAuthCredential

Representasi JSON
{
  "oauthTokenSecretVersion": string,
  "username": string
}
Kolom
oauthTokenSecretVersion

string

Wajib. Resource SecretManager yang berisi token OAuth yang mengizinkan koneksi. Format: projects/*/secrets/*/versions/* atau projects/*/locations/*/secrets/*/versions/* (jika secret regional didukung di lokasi tersebut).

username

string

Hanya output. Nama pengguna yang terkait dengan token ini.

GitHubEnterpriseConfig

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

string

Wajib. URI host GitHub Enterprise yang dituju oleh koneksi ini.

appId

string (int64 format)

Opsional. ID Aplikasi GitHub yang dibuat dari manifes.

appSlug

string

Hanya output. Nama Aplikasi GitHub yang sesuai dengan URL.

privateKeySecretVersion

string

Opsional. Resource SecretManager yang berisi kunci pribadi Aplikasi GitHub, yang diformat sebagai projects/*/secrets/*/versions/* atau projects/*/locations/*/secrets/*/versions/* (jika secret regional didukung di lokasi tersebut).

webhookSecretSecretVersion

string

Opsional. Resource SecretManager yang berisi secret webhook Aplikasi GitHub, yang diformat sebagai projects/*/secrets/*/versions/* atau projects/*/locations/*/secrets/*/versions/* (jika secret regional didukung di lokasi tersebut).

appInstallationId

string (int64 format)

Opsional. ID penginstalan Aplikasi GitHub.

installationUri

string

Hanya output. URI yang akan dibuka untuk mengelola penginstalan yang terkait dengan GitHubEnterpriseConfig ini.

serviceDirectoryConfig

object (ServiceDirectoryConfig)

Opsional. Konfigurasi untuk menggunakan Direktori Layanan agar terhubung secara pribadi ke server GitHub Enterprise. Ini hanya boleh ditetapkan jika server GitHub Enterprise dihosting secara lokal dan tidak dapat dijangkau oleh internet publik. Jika kolom ini dibiarkan kosong, panggilan ke server GitHub Enterprise akan dilakukan melalui internet publik.

serverVersion

string

Hanya output. Versi GitHub Enterprise yang diinstal di host_uri.

sslCaCertificate

string

Opsional. Sertifikat SSL yang akan digunakan untuk permintaan ke GitHub Enterprise.

organization

string

Opsional. Tidak dapat diubah. Organisasi GitHub Enterprise tempat Aplikasi GitHub dibuat.

ServiceDirectoryConfig

Representasi JSON
{
  "service": string
}
Kolom
service

string

Wajib. Nama layanan Direktori Layanan. Format: projects/{project}/locations/{location}/namespaces/{namespace}/services/{service}.

GitLabConfig

Representasi JSON
{
  "webhookSecretSecretVersion": string,
  "readAuthorizerCredential": {
    object (UserCredential)
  },
  "authorizerCredential": {
    object (UserCredential)
  }
}
Kolom
webhookSecretSecretVersion

string

Wajib. Tidak dapat diubah. Resource SecretManager yang berisi secret webhook project GitLab, yang diformat sebagai projects/*/secrets/*/versions/* atau projects/*/locations/*/secrets/*/versions/* (jika secret regional didukung di lokasi tersebut). Kunci ini digunakan untuk memvalidasi webhook.

readAuthorizerCredential

object (UserCredential)

Wajib. Token akses pribadi GitLab dengan akses cakupan read_api minimum dan peran reporter minimum. Project GitLab yang terlihat oleh Token Akses Pribadi ini akan mengontrol Project mana yang dapat diakses oleh Developer Connect.

authorizerCredential

object (UserCredential)

Wajib. Token akses pribadi GitLab dengan akses cakupan api minimum dan peran maintainer minimum. Project GitLab yang terlihat oleh Token Akses Pribadi ini akan mengontrol Project mana yang dapat diakses oleh Developer Connect.

UserCredential

Representasi JSON
{
  "userTokenSecretVersion": string,
  "username": string
}
Kolom
userTokenSecretVersion

string

Wajib. Resource SecretManager yang berisi token pengguna yang mengizinkan koneksi Developer Connect. Format: projects/*/secrets/*/versions/* atau projects/*/locations/*/secrets/*/versions/* (jika secret regional didukung di lokasi tersebut).

username

string

Hanya output. Nama pengguna yang terkait dengan token ini.

GitLabEnterpriseConfig

Representasi JSON
{
  "hostUri": string,
  "webhookSecretSecretVersion": string,
  "readAuthorizerCredential": {
    object (UserCredential)
  },
  "authorizerCredential": {
    object (UserCredential)
  },
  "serviceDirectoryConfig": {
    object (ServiceDirectoryConfig)
  },
  "sslCaCertificate": string,
  "serverVersion": string
}
Kolom
hostUri

string

Wajib. URI host GitLab Enterprise yang dituju oleh koneksi ini.

webhookSecretSecretVersion

string

Wajib. Tidak dapat diubah. Resource SecretManager yang berisi secret webhook project GitLab, yang diformat sebagai projects/*/secrets/*/versions/* atau projects/*/locations/*/secrets/*/versions/* (jika secret regional didukung di lokasi tersebut). Kunci ini digunakan untuk memvalidasi webhook.

readAuthorizerCredential

object (UserCredential)

Wajib. Token akses pribadi GitLab dengan akses cakupan read_api minimum dan peran reporter minimum. Project GitLab yang terlihat oleh Token Akses Pribadi ini akan mengontrol Project mana yang dapat diakses oleh Developer Connect.

authorizerCredential

object (UserCredential)

Wajib. Token akses pribadi GitLab dengan akses cakupan api minimum dan peran maintainer minimum. Project GitLab yang terlihat oleh Token Akses Pribadi ini akan mengontrol Project mana yang dapat diakses oleh Developer Connect.

serviceDirectoryConfig

object (ServiceDirectoryConfig)

Opsional. Konfigurasi untuk menggunakan Direktori Layanan agar terhubung secara pribadi ke instance GitLab Enterprise. Ini hanya boleh ditetapkan jika server GitLab Enterprise dihosting secara lokal dan tidak dapat dijangkau oleh internet publik. Jika kolom ini dibiarkan kosong, panggilan ke server GitLab Enterprise akan dilakukan melalui internet publik.

sslCaCertificate

string

Opsional. Sertifikat SSL Certificate Authority yang akan digunakan untuk permintaan ke instance GitLab Enterprise.

serverVersion

string

Hanya output. Versi server GitLab Enterprise yang berjalan di host_uri.

BitbucketDataCenterConfig

Representasi JSON
{
  "hostUri": string,
  "webhookSecretSecretVersion": string,
  "readAuthorizerCredential": {
    object (UserCredential)
  },
  "authorizerCredential": {
    object (UserCredential)
  },
  "serviceDirectoryConfig": {
    object (ServiceDirectoryConfig)
  },
  "sslCaCertificate": string,
  "serverVersion": string
}
Kolom
hostUri

string

Wajib. URI host Bitbucket Data Center yang dituju oleh koneksi ini.

webhookSecretSecretVersion

string

Wajib. Tidak dapat diubah. Resource SecretManager yang berisi rahasia webhook yang digunakan untuk memverifikasi peristiwa webhook, yang diformat sebagai projects/*/secrets/*/versions/* atau projects/*/locations/*/secrets/*/versions/* (jika rahasia regional didukung di lokasi tersebut). Kunci ini digunakan untuk memvalidasi webhook.

readAuthorizerCredential

object (UserCredential)

Wajib. Token akses http dengan akses Repository read minimum. Sebaiknya gunakan akun sistem untuk membuat kredensial.

authorizerCredential

object (UserCredential)

Wajib. Token akses http dengan akses cakupan Repository admin minimum. Langkah ini diperlukan untuk membuat webhook. Sebaiknya gunakan akun sistem untuk membuat kredensial ini.

serviceDirectoryConfig

object (ServiceDirectoryConfig)

Opsional. Konfigurasi untuk menggunakan Direktori Layanan agar terhubung secara pribadi ke instance Pusat Data Bitbucket. Ini hanya boleh ditetapkan jika Bitbucket Data Center dihosting secara lokal dan tidak dapat dijangkau oleh internet publik. Jika kolom ini dibiarkan kosong, panggilan ke Bitbucket Data Center akan dilakukan melalui internet publik.

sslCaCertificate

string

Opsional. Otoritas sertifikat SSL yang dipercaya saat membuat permintaan ke Bitbucket Data Center.

serverVersion

string

Hanya output. Versi server Pusat Data Bitbucket yang berjalan di host_uri.

BitbucketCloudConfig

Representasi JSON
{
  "workspace": string,
  "webhookSecretSecretVersion": string,
  "readAuthorizerCredential": {
    object (UserCredential)
  },
  "authorizerCredential": {
    object (UserCredential)
  }
}
Kolom
workspace

string

Wajib. ID Workspace Bitbucket Cloud yang akan dihubungkan ke Google Cloud Platform.

webhookSecretSecretVersion

string

Wajib. Tidak dapat diubah. Resource SecretManager yang berisi rahasia webhook yang digunakan untuk memverifikasi peristiwa webhook, yang diformat sebagai projects/*/secrets/*/versions/* atau projects/*/locations/*/secrets/*/versions/* (jika rahasia regional didukung di lokasi tersebut). Ini digunakan untuk memvalidasi dan membuat webhook.

readAuthorizerCredential

object (UserCredential)

Wajib. Token akses dengan akses repository minimum. Token ini dapat berupa token akses ruang kerja, project, atau repositori. Sebaiknya gunakan akun sistem untuk membuat kredensial.

authorizerCredential

object (UserCredential)

Wajib. Token akses dengan akses cakupan repository, pullrequest, dan webhook minimum. Token ini dapat berupa token akses ruang kerja, project, atau repositori. Langkah ini diperlukan untuk membuat webhook. Sebaiknya gunakan akun sistem untuk membuat kredensial ini.

SecureSourceManagerInstanceConfig

Representasi JSON
{
  "instance": string
}
Kolom
instance

string

Wajib. Tidak dapat diubah. Resource instance Secure Source Manager, yang diformat sebagai projects/*/locations/*/instances/*

GenericHTTPEndpointConfig

Representasi JSON
{
  "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.
}
Kolom
hostUri

string

Wajib. Tidak dapat diubah. Endpoint https penyedia layanan.

serviceDirectoryConfig

object (ServiceDirectoryConfig)

Opsional. Konfigurasi untuk menggunakan Direktori Layanan agar terhubung secara pribadi ke penyedia layanan HTTP. Setelan ini hanya boleh ditetapkan jika penyedia layanan Http dihosting secara lokal dan tidak dapat dijangkau oleh internet publik. Jika kolom ini dibiarkan kosong, panggilan ke penyedia layanan HTTP akan dilakukan melalui internet publik.

sslCaCertificate

string

Opsional. Sertifikat SSL yang akan digunakan untuk permintaan ke penyedia layanan HTTP.

Kolom union authentication. Mekanisme autentikasi yang akan digunakan untuk permintaan ke penyedia layanan HTTP. authentication hanya ada berupa salah satu diantara berikut:
basicAuthentication

object (BasicAuthentication)

Opsional. Autentikasi dasar dengan nama pengguna dan sandi.

bearerTokenAuthentication

object (BearerTokenAuthentication)

Opsional. Autentikasi token pemilik dengan token.

BasicAuthentication

Representasi JSON
{
  "username": string,

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

string

Wajib. Nama pengguna yang akan diautentikasi.

Kolom union password. Sandi untuk melakukan autentikasi. password hanya ada berupa salah satu diantara berikut:
passwordSecretVersion

string

Versi secret SecretManager sandi untuk melakukan autentikasi.

BearerTokenAuthentication

Representasi JSON
{

  // Union field token can be only one of the following:
  "tokenSecretVersion": string
  // End of list of possible types for union field token.
}
Kolom
Kolom union token. Token untuk melakukan autentikasi. token hanya ada berupa salah satu diantara berikut:
tokenSecretVersion

string

Opsional. Versi secret SecretManager token untuk melakukan autentikasi.

Stempel waktu

Representasi JSON
{
  "seconds": string,
  "nanos": integer
}
Kolom
seconds

string (int64 format)

Mewakili detik waktu UTC sejak epoch Unix 1970-01-01T00:00:00Z. Harus antara -62135596800 dan 253402300799 inklusif (yang sesuai dengan 0001-01-01T00:00:00Z hingga 9999-12-31T23:59:59Z).

nanos

integer

Pecahan detik non-negatif pada resolusi nanodetik. Kolom ini adalah bagian nanodetik dari durasi, bukan alternatif untuk detik. Nilai detik negatif dengan pecahan harus tetap memiliki nilai nano non-negatif yang dihitung maju dalam waktu. Harus antara 0 dan 999.999.999 inklusif.

LabelsEntry

Representasi JSON
{
  "key": string,
  "value": string
}
Kolom
key

string

value

string

InstallationState

Representasi JSON
{
  "stage": enum (Stage),
  "message": string,
  "actionUri": string
}
Kolom
stage

enum (Stage)

Hanya output. Langkah saat ini dalam proses penginstalan.

message

string

Hanya output. Pesan tentang tindakan yang harus dilakukan pengguna selanjutnya untuk melanjutkan penginstalan. String kosong jika penginstalan sudah selesai.

actionUri

string

Hanya output. Link yang harus diikuti untuk tindakan berikutnya. String kosong jika penginstalan sudah selesai.

AnnotationsEntry

Representasi JSON
{
  "key": string,
  "value": string
}
Kolom
key

string

value

string

CryptoKeyConfig

Representasi JSON
{
  "keyReference": string
}
Kolom
keyReference

string

Wajib. Nama kunci yang digunakan untuk mengenkripsi/mendekripsi data pelanggan. Untuk kunci di Cloud KMS, kunci harus dalam format projects/*/locations/*/keyRings/*/cryptoKeys/*.

GitProxyConfig

Representasi JSON
{
  "enabled": boolean,
  "httpProxyBaseUri": string
}
Kolom
enabled

boolean

Opsional. Menetapkan nilai ini ke true (benar) akan memungkinkan proxy Git digunakan untuk melakukan operasi Git pada repositori yang ditautkan dalam koneksi.

httpProxyBaseUri

string

Hanya output. URI dasar untuk endpoint proxy HTTP. Memiliki format https://{generatedID}-c-h-{shortRegion}.developerconnect.dev Hanya diisi jika diaktifkan ditetapkan ke benar (true). Endpoint ini digunakan oleh layanan Google lainnya yang terintegrasi dengan Developer Connect.

GitHubApp

Merepresentasikan berbagai Aplikasi GitHub yang dapat diinstal ke pengguna atau organisasi GitHub dan digunakan dengan Developer Connect.

Enum
GIT_HUB_APP_UNSPECIFIED Aplikasi GitHub tidak ditentukan.
DEVELOPER_CONNECT Aplikasi GitHub Developer Connect.
FIREBASE Aplikasi GitHub Firebase.
GEMINI_CODE_ASSIST Aplikasi Gemini Code Assist.
DATAFORM Aplikasi GitHub Dataform.

Tahap

Tahap proses penginstalan.

Enum
STAGE_UNSPECIFIED Tidak ada tahap yang ditentukan.
PENDING_CREATE_APP Hanya untuk GitHub Enterprise. Pembuatan Aplikasi telah diminta. Pengguna harus mengonfirmasi pembuatan di host GitHub Enterprise mereka.
PENDING_USER_OAUTH Pengguna harus mengizinkan Aplikasi GitHub (atau Enterprise) melalui OAuth.
PENDING_INSTALL_APP Pengguna harus mengikuti link untuk menginstal Aplikasi GitHub (atau Enterprise).
COMPLETE Proses penginstalan telah selesai.

Skema Output

Resource ini mewakili operasi yang berjalan lama yang merupakan hasil dari panggilan API jaringan.

Operasi

Representasi JSON
{
  "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.
}
Kolom
name

string

Nama server yang ditetapkan, yang hanya bersifat unik dalam layanan yang sama yang awalnya menampilkannya. Jika Anda menggunakan pemetaan HTTP default, name harus berupa nama resource yang diakhiri dengan operations/{unique_id}.

metadata

object

Metadata khusus layanan yang terkait dengan operasi. Biasanya berisi informasi kemajuan dan metadata umum, seperti membuat waktu. Beberapa layanan mungkin tidak menyediakan metadata semacam itu. Setiap metode yang menampilkan operasi yang berjalan lama harus mendokumentasikan tipe metadata, jika ada.

Objek yang berisi kolom tipe arbitrer. Kolom tambahan "@type" berisi URI yang mengidentifikasi jenis. Contoh: { "id": 1234, "@type": "types.example.com/standard/id" }.

done

boolean

Jika nilainya adalah false, artinya operasi masih berlangsung. Jika true, artinya operasi sudah selesai, dan error atau response tersedia.

Kolom union result. Hasil operasi, yang dapat berupa error atau response yang valid. Jika done == false, error atau response tidak ditetapkan. Jika done == true, hanya salah satu dari error atau response yang dapat ditetapkan. Beberapa layanan mungkin tidak memberikan hasil. result hanya dapat berupa salah satu dari berikut:
error

object (Status)

Hasil error operasi jika terjadi kegagalan atau pembatalan.

response

object

Respons normal dan berhasil dari operasi. Jika metode asli tidak menampilkan data saat berhasil, seperti Delete, responsnya adalah google.protobuf.Empty. Jika metode asli adalah Get/Create/Update standar, responsnya harus berupa resource. Untuk metode lain, respons harus memiliki jenis XxxResponse, dengan Xxx yang merupakan nama metode asli. Misalnya, jika nama metode asli adalah TakeSnapshot(), jenis respons yang disimpulkan adalah TakeSnapshotResponse.

Objek yang berisi kolom tipe arbitrer. Kolom tambahan "@type" berisi URI yang mengidentifikasi jenis. Contoh: { "id": 1234, "@type": "types.example.com/standard/id" }.

Semua

Representasi JSON
{
  "typeUrl": string,
  "value": string
}
Kolom
typeUrl

string

Mengidentifikasi jenis pesan Protobuf yang diserialisasi dengan referensi URI yang terdiri dari awalan yang diakhiri dengan garis miring dan nama jenis yang sepenuhnya memenuhi syarat.

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

String ini harus berisi setidaknya satu karakter /, dan konten setelah / terakhir harus berupa nama jenis yang sepenuhnya memenuhi syarat dalam bentuk kanonis, tanpa titik di awal. Jangan menulis skema pada referensi URI ini agar klien tidak mencoba menghubunginya.

Prefiks bersifat arbitrer dan implementasi Protobuf diharapkan hanya menghapus semua hal hingga dan termasuk / terakhir untuk mengidentifikasi jenisnya. type.googleapis.com/ adalah awalan default umum yang diperlukan oleh beberapa implementasi lama. Awalan ini tidak menunjukkan asal jenis, dan URI yang memuatnya tidak diharapkan untuk merespons permintaan apa pun.

Semua string URL jenis harus berupa referensi URI yang sah dengan batasan tambahan (untuk format teks) bahwa konten referensi hanya boleh terdiri dari karakter alfanumerik, escape yang dienkode persen, dan karakter dalam kumpulan berikut (tidak termasuk tanda petik terbalik luar): /-.~_!$&()*+,;=. Meskipun kami mengizinkan encoding persen, implementasi tidak boleh meng-unescape-nya untuk mencegah kebingungan dengan parser yang ada. Misalnya, type.googleapis.com%2FFoo harus ditolak.

Dalam desain asli Any, kemungkinan meluncurkan layanan resolusi jenis di URL jenis ini telah dipertimbangkan, tetapi Protobuf tidak pernah menerapkannya dan menganggap menghubungi URL ini sebagai masalah dan potensi masalah keamanan. Jangan mencoba menghubungi URL jenis.

value

string (bytes format)

Menyimpan serialisasi Protobuf dari jenis yang dijelaskan oleh type_url.

String berenkode base64.

Status

Representasi JSON
{
  "code": integer,
  "message": string,
  "details": [
    {
      "@type": string,
      field1: ...,
      ...
    }
  ]
}
Kolom
code

integer

Kode status, harus berupa nilai enum dari google.rpc.Code.

message

string

Pesan error yang ditampilkan ke developer dan seharusnya dalam bahasa Inggris. Setiap pesan error yang ditampilkan kepada pengguna harus dilokalkan dan dikirim di kolom google.rpc.Status.details, atau dilokalkan oleh klien.

details[]

object

Daftar pesan yang membawa detail error. Ada seperangkat jenis pesan umum untuk digunakan API.

Objek yang berisi kolom tipe arbitrer. Kolom tambahan "@type" berisi URI yang mengidentifikasi jenis. Contoh: { "id": 1234, "@type": "types.example.com/standard/id" }.

Anotasi Alat

Anotasi alat dikirim ke klien MCP untuk menjelaskan risiko dasar alat tertentu. Sebagian besar klien memperlakukan petunjuk ini sebagai tidak tepercaya, tetapi petunjuk tersebut dapat digunakan untuk memutuskan kapan perintah konfirmasi dapat dikirim kepada pengguna.

Bersama dengan string judul, petunjuk boolean berikut ditentukan sebagai berikut:

  • readOnlyHint: Jika benar, alat tidak akan mengubah lingkungannya. Default: false.
  • destructiveHint: Jika benar, alat dapat melakukan tindakan destruktif. Jika salah (false), alat hanya dapat melakukan tindakan aditif. Default: true.
  • idempotentHint: Jika benar, memanggil alat berulang kali dengan argumen yang sama tidak akan memberikan efek tambahan pada lingkungannya. Default: false.
  • openWorldHint: Jika benar, alat dapat berinteraksi dengan 'open world' entitas eksternal. Jika salah, alat hanya dapat berinteraksi dengan entity internal. Misalnya, alat penelusuran web akan bersifat open world, sedangkan alat memori tidak akan bersifat open world.

Destructive Hint: ❌ | Idempotent Hint: ❌ | Read Only Hint: ❌ | Open World Hint: ❌