כלי: list-connections
הצגת רשימה של החיבורים בפרויקט ובמיקום נתונים.
בדוגמת הקוד הבאה מוסבר איך להשתמש ב-curl כדי להפעיל את כלי ה-MCP list-connections.
| בקשת 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": "list-connections", "arguments": { // Provide these details according to the MCP tool specification. } }, "jsonrpc": "2.0", "id": 1 }' |
סכימת הקלט
הודעה לבקשת רשימת החיבורים
ListConnectionsRequest
| ייצוג ב-JSON |
|---|
{ "parent": string, "pageSize": integer, "pageToken": string, "filter": string, "orderBy": string } |
| שדות | |
|---|---|
parent |
חובה. ערך ההורה של ListConnectionsRequest |
pageSize |
זה שינוי אופציונלי. גודל הדף המבוקש. יכול להיות שהשרת יחזיר פחות פריטים מהמספר שביקשתם. אם לא צוין, השרת יבחר ברירת מחדל מתאימה. |
pageToken |
זה שינוי אופציונלי. אסימון שמזהה את דף התוצאות שהשרת צריך להחזיר. |
filter |
זה שינוי אופציונלי. המערכת מסננת את התוצאות. |
orderBy |
זה שינוי אופציונלי. רמז לגבי סדר התוצאות. |
סכימת הפלט
הודעה לתשובה על בקשות לקישור לפרופיל העסק
ListConnectionsResponse
| ייצוג ב-JSON |
|---|
{
"connections": [
{
object ( |
| שדות | |
|---|---|
connections[] |
רשימת החיבורים. |
nextPageToken |
אסימון שמזהה את דף התוצאות שהשרת צריך להחזיר. |
unreachable[] |
מיקומים שלא ניתן להגיע אליהם. |
חיבור
| ייצוג ב-JSON |
|---|
{ "name": string, "createTime": string, "updateTime": string, "deleteTime": string, "labels": { string: string, ... }, "installationState": { object ( |
| שדות | |
|---|---|
name |
מזהה. שם המשאב של החיבור, בפורמט |
createTime |
פלט בלבד. חותמת זמן היצירה. הפורמט הוא RFC 3339, והפלט שנוצר תמיד יהיה מנורמל ל-Z וישתמש ב-0, 3, 6 או 9 ספרות אחרי הנקודה העשרונית. אפשר להשתמש גם בהיסטים אחרים, לא רק ב-Z. לדוגמה: |
updateTime |
פלט בלבד. עדכון חותמת הזמן. הפורמט הוא RFC 3339, והפלט שנוצר תמיד יהיה מנורמל ל-Z וישתמש ב-0, 3, 6 או 9 ספרות אחרי הנקודה העשרונית. אפשר להשתמש גם בהיסטים אחרים, לא רק ב-Z. לדוגמה: |
deleteTime |
פלט בלבד. מחיקת חותמת הזמן. הפורמט הוא RFC 3339, והפלט שנוצר תמיד יהיה מנורמל ל-Z וישתמש ב-0, 3, 6 או 9 ספרות אחרי הנקודה העשרונית. אפשר להשתמש גם בהיסטים אחרים, לא רק ב-Z. לדוגמה: |
labels |
זה שינוי אופציונלי. תוויות כצמדי מפתח/ערך אובייקט שמכיל רשימה של זוגות |
installationState |
פלט בלבד. סטטוס ההתקנה של החיבור. |
disabled |
זה שינוי אופציונלי. אם הערך של disabled מוגדר כ-true, הפונקציונליות מושבתת בחיבור הזה. שיטות API שמבוססות על מאגרים ועיבוד של תגובות לפעולה מאתר אחר (webhook) למאגרים בחיבור הזה יושבתו. |
reconciling |
פלט בלבד. צריך להגדיר את הערך כ-true כשהחיבור מוגדר או מתעדכן ברקע. |
annotations |
זה שינוי אופציונלי. מאפשר ללקוחות לאחסן כמויות קטנות של נתונים שרירותיים. אובייקט שמכיל רשימה של זוגות |
etag |
זה שינוי אופציונלי. סיכום הביקורת הזה מחושב על ידי השרת על סמך הערך של שדות אחרים, ויכול להיות שיישלח בבקשות עדכון ומחיקה כדי לוודא שללקוח יש ערך עדכני לפני שממשיכים. |
uid |
פלט בלבד. מזהה ייחודי שהמערכת מקצה לחיבור. |
cryptoKeyConfig |
זה שינוי אופציונלי. ההגדרות של מפתח ההצפנה. השדה הזה משמש את התכונה "מפתחות הצפנה בניהול הלקוח" (CMEK). |
gitProxyConfig |
זה שינוי אופציונלי. הגדרת התכונה "שרת proxy של Git". הפעלת שרת ה-proxy של Git מאפשרת ללקוחות לבצע פעולות Git במאגרים שמקושרים בחיבור. מידע נוסף |
שדה של איחוד connection_config. הגדרת החיבור בהתאם לסוג הספק. הערך connection_config יכול להיות רק אחד מהבאים: |
|
githubConfig |
הגדרת החיבורים ל-github.com. |
githubEnterpriseConfig |
הגדרת החיבורים למכונה של GitHub Enterprise. |
gitlabConfig |
הגדרת החיבורים ל-gitlab.com. |
gitlabEnterpriseConfig |
הגדרת החיבורים למכונה של GitLab Enterprise. |
bitbucketDataCenterConfig |
הגדרת החיבורים למכונה של Bitbucket Data Center. |
bitbucketCloudConfig |
הגדרת החיבורים למכונה של Bitbucket Clouds. |
secureSourceManagerInstanceConfig |
הגדרת החיבורים למכונה של Secure Source Manager. |
httpConfig |
זה שינוי אופציונלי. הגדרת החיבורים לספק שירות HTTP. |
GitHubConfig
| ייצוג ב-JSON |
|---|
{ "githubApp": enum ( |
| שדות | |
|---|---|
githubApp |
חובה. לא ניתן לשינוי. אפליקציית GitHub שהותקנה למשתמש או לארגון ב-GitHub. |
authorizerCredential |
זה שינוי אופציונלי. פרטי הכניסה ל-OAuth של החשבון שנתן הרשאה לאפליקציית GitHub. מומלץ להשתמש בחשבון רובוט במקום בחשבון משתמש אנושי. אסימון ה-OAuth חייב להיות מקושר לאפליקציית GitHub של ההגדרה הזו. |
appInstallationId |
זה שינוי אופציונלי. מזהה ההתקנה של אפליקציית GitHub. |
installationUri |
פלט בלבד. ה-URI שאליו צריך לנווט כדי לנהל את ההתקנה שמשויכת ל-GitHubConfig הזה. |
OAuthCredential
| ייצוג ב-JSON |
|---|
{ "oauthTokenSecretVersion": string, "username": string } |
| שדות | |
|---|---|
oauthTokenSecretVersion |
חובה. משאב SecretManager שמכיל את אסימון ה-OAuth שמאשר את החיבור. פורמט: |
username |
פלט בלבד. שם המשתמש שמשויך לטוקן הזה. |
GitHubEnterpriseConfig
| ייצוג ב-JSON |
|---|
{
"hostUri": string,
"appId": string,
"appSlug": string,
"privateKeySecretVersion": string,
"webhookSecretSecretVersion": string,
"appInstallationId": string,
"installationUri": string,
"serviceDirectoryConfig": {
object ( |
| שדות | |
|---|---|
hostUri |
חובה. ה-URI של מארח GitHub Enterprise שהחיבור הזה מיועד לו. |
appId |
זה שינוי אופציונלי. מזהה אפליקציית GitHub שנוצרה מהמניפסט. |
appSlug |
פלט בלבד. השם של אפליקציית GitHub שמתאים לכתובת URL. |
privateKeySecretVersion |
זה שינוי אופציונלי. משאב SecretManager שמכיל את המפתח הפרטי של אפליקציית GitHub, בפורמט |
webhookSecretSecretVersion |
זה שינוי אופציונלי. משאב SecretManager שמכיל את הסוד של ה-webhook של אפליקציית GitHub, בפורמט |
appInstallationId |
זה שינוי אופציונלי. מזהה ההתקנה של אפליקציית GitHub. |
installationUri |
פלט בלבד. ה-URI שאליו צריך לנווט כדי לנהל את ההתקנה שמשויכת ל-GitHubEnterpriseConfig הזה. |
serviceDirectoryConfig |
זה שינוי אופציונלי. הגדרה לשימוש ב-Service Directory כדי להתחבר באופן פרטי לשרת GitHub Enterprise. צריך להגדיר את זה רק אם שרת GitHub Enterprise מתארח באופן מקומי ואי אפשר להגיע אליו דרך האינטרנט הציבורי. אם השדה הזה נשאר ריק, הקריאות לשרת GitHub Enterprise יתבצעו דרך האינטרנט הציבורי. |
serverVersion |
פלט בלבד. גרסת GitHub Enterprise שמותקנת ב-host_uri. |
sslCaCertificate |
זה שינוי אופציונלי. אישור SSL לשימוש בבקשות ל-GitHub Enterprise. |
organization |
זה שינוי אופציונלי. לא ניתן לשינוי. הארגון ב-GitHub Enterprise שבו נוצרה אפליקציית GitHub. |
ServiceDirectoryConfig
| ייצוג ב-JSON |
|---|
{ "service": string } |
| שדות | |
|---|---|
service |
חובה. השם של השירות ב-Service Directory. פורמט: projects/{project}/locations/{location}/namespaces/{namespace}/services/{service}. |
GitLabConfig
| ייצוג ב-JSON |
|---|
{ "webhookSecretSecretVersion": string, "readAuthorizerCredential": { object ( |
| שדות | |
|---|---|
webhookSecretSecretVersion |
חובה. לא ניתן לשינוי. משאב SecretManager שמכיל את הסוד של ה-webhook של פרויקט GitLab, בפורמט |
readAuthorizerCredential |
חובה. טוקן גישה אישי של GitLab עם גישה מינימלית להיקף |
authorizerCredential |
חובה. טוקן גישה אישי של GitLab עם גישה מינימלית להיקף |
UserCredential
| ייצוג ב-JSON |
|---|
{ "userTokenSecretVersion": string, "username": string } |
| שדות | |
|---|---|
userTokenSecretVersion |
חובה. משאב SecretManager שמכיל את אסימון המשתמש שמאשר את החיבור של Developer Connect. פורמט: |
username |
פלט בלבד. שם המשתמש שמשויך לטוקן הזה. |
GitLabEnterpriseConfig
| ייצוג ב-JSON |
|---|
{ "hostUri": string, "webhookSecretSecretVersion": string, "readAuthorizerCredential": { object ( |
| שדות | |
|---|---|
hostUri |
חובה. ה-URI של מארח GitLab Enterprise שהחיבור הזה מיועד לו. |
webhookSecretSecretVersion |
חובה. לא ניתן לשינוי. משאב SecretManager שמכיל את הסוד של ה-webhook של פרויקט GitLab, בפורמט |
readAuthorizerCredential |
חובה. טוקן גישה אישי של GitLab עם גישה מינימלית להיקף |
authorizerCredential |
חובה. טוקן גישה אישי של GitLab עם גישה מינימלית להיקף |
serviceDirectoryConfig |
זה שינוי אופציונלי. הגדרת השימוש ב-Service Directory כדי להתחבר באופן פרטי למכונה של GitLab Enterprise. צריך להגדיר את זה רק אם שרת GitLab Enterprise מתארח באופן מקומי ואי אפשר להגיע אליו דרך האינטרנט הציבורי. אם השדה הזה ריק, הקריאות לשרת GitLab Enterprise יתבצעו דרך האינטרנט הציבורי. |
sslCaCertificate |
זה שינוי אופציונלי. אישור של רשות אישורי SSL לשימוש בבקשות למכונה של GitLab Enterprise. |
serverVersion |
פלט בלבד. גרסת השרת של GitLab Enterprise שפועלת ב- |
BitbucketDataCenterConfig
| ייצוג ב-JSON |
|---|
{ "hostUri": string, "webhookSecretSecretVersion": string, "readAuthorizerCredential": { object ( |
| שדות | |
|---|---|
hostUri |
חובה. ה-URI של מארח מרכז הנתונים של Bitbucket שהחיבור הזה מיועד לו. |
webhookSecretSecretVersion |
חובה. לא ניתן לשינוי. משאב SecretManager שמכיל את הסוד של ה-webhook שמשמש לאימות אירועי webhook, בפורמט |
readAuthorizerCredential |
חובה. טוקן גישה מסוג HTTP עם גישה מינימלית ל- |
authorizerCredential |
חובה. אסימון גישה מסוג HTTP עם גישה מינימלית להיקף |
serviceDirectoryConfig |
זה שינוי אופציונלי. הגדרת השימוש ב-Service Directory כדי להתחבר באופן פרטי למכונה של Bitbucket Data Center. צריך להגדיר את זה רק אם מרכז הנתונים של Bitbucket מתארח באופן מקומי ואי אפשר להגיע אליו דרך האינטרנט הציבורי. אם השדה הזה יישאר ריק, הקריאות ל-Bitbucket Data Center יתבצעו דרך האינטרנט הציבורי. |
sslCaCertificate |
זה שינוי אופציונלי. רשות אישורי ה-SSL שצריך לתת בה אמון כששולחים בקשות ל-Bitbucket מרכז נתונים. |
serverVersion |
פלט בלבד. גרסת השרת של Bitbucket Data Center שפועלת ב- |
BitbucketCloudConfig
| ייצוג ב-JSON |
|---|
{ "workspace": string, "webhookSecretSecretVersion": string, "readAuthorizerCredential": { object ( |
| שדות | |
|---|---|
workspace |
חובה. מזהה סביבת העבודה ב-Bitbucket Cloud שרוצים לקשר ל-Google Cloud Platform. |
webhookSecretSecretVersion |
חובה. לא ניתן לשינוי. משאב SecretManager שמכיל את הסוד של ה-webhook שמשמש לאימות אירועי webhook, בפורמט |
readAuthorizerCredential |
חובה. טוקן גישה עם הרשאת הגישה המינימלית ל- |
authorizerCredential |
חובה. טוקן גישה עם היקף הגישה המינימלי של |
SecureSourceManagerInstanceConfig
| ייצוג ב-JSON |
|---|
{ "instance": string } |
| שדות | |
|---|---|
instance |
חובה. לא ניתן לשינוי. משאב של מכונה ב-Secure Source Manager, בפורמט |
GenericHTTPEndpointConfig
| ייצוג ב-JSON |
|---|
{ "hostUri": string, "serviceDirectoryConfig": { object ( |
| שדות | |
|---|---|
hostUri |
חובה. לא ניתן לשינוי. נקודת הקצה (endpoint) ב-HTTPS של ספק השירות. |
serviceDirectoryConfig |
זה שינוי אופציונלי. הגדרה לשימוש ב-Service Directory כדי להתחבר באופן פרטי לספק שירות HTTP. צריך להגדיר את זה רק אם ספק שירות ה-HTTP מתארח באופן מקומי ואי אפשר להגיע אליו דרך האינטרנט הציבורי. אם השדה הזה נשאר ריק, הקריאות לספק שירות ה-HTTP יתבצעו דרך האינטרנט הציבורי. |
sslCaCertificate |
זה שינוי אופציונלי. אישור ה-SSL שבו צריך להשתמש לבקשות לספק שירות ה-HTTP. |
שדה של איחוד authentication. מנגנון האימות שבו צריך להשתמש לבקשות לספק שירות ה-HTTP. הערך authentication יכול להיות רק אחד מהבאים: |
|
basicAuthentication |
זה שינוי אופציונלי. אימות בסיסי באמצעות שם משתמש וסיסמה. |
bearerTokenAuthentication |
זה שינוי אופציונלי. אימות טוקן למוכ"ז באמצעות טוקן. |
BasicAuthentication
| ייצוג ב-JSON |
|---|
{ "username": string, // Union field |
| שדות | |
|---|---|
username |
חובה. שם המשתמש לאימות. |
שדה של איחוד password. הסיסמה לאימות. הערך password יכול להיות רק אחד מהבאים: |
|
passwordSecretVersion |
גרסת הסוד של SecretManager של הסיסמה לאימות. |
BearerTokenAuthentication
| ייצוג ב-JSON |
|---|
{ // Union field |
| שדות | |
|---|---|
שדה של איחוד token. האסימון לאימות. הערך token יכול להיות רק אחד מהבאים: |
|
tokenSecretVersion |
זה שינוי אופציונלי. גרסת הסוד של SecretManager של הטוקן שמשמש לאימות. |
חותמת הזמן
| ייצוג ב-JSON |
|---|
{ "seconds": string, "nanos": integer } |
| שדות | |
|---|---|
seconds |
מייצג שניות של זמן UTC מאז ראשית זמן יוניקס (Unix epoch) 1970-01-01T00:00:00Z. הערך חייב להיות בין -62135596800 ל-253402300799, כולל (טווח שמתאים ל-0001-01-01T00:00:00Z עד 9999-12-31T23:59:59Z). |
nanos |
שברים לא שליליים של שנייה ברזולוציה של ננו-שנייה. השדה הזה הוא החלק של הננו-שניות במשך הזמן, ולא חלופה לשניות. ערכי שניות שליליים עם שברים עדיין צריכים לכלול ערכי ננו-שניות לא שליליים שנספרים קדימה בזמן. הערך חייב להיות בין 0 ל-999,999,999, כולל. |
LabelsEntry
| ייצוג ב-JSON |
|---|
{ "key": string, "value": string } |
| שדות | |
|---|---|
key |
|
value |
|
InstallationState
| ייצוג ב-JSON |
|---|
{
"stage": enum ( |
| שדות | |
|---|---|
stage |
פלט בלבד. השלב הנוכחי בתהליך ההתקנה. |
message |
פלט בלבד. הודעה שמסבירה מה המשתמש צריך לעשות כדי להמשיך בהתקנה. מחרוזת ריקה אם ההתקנה כבר הושלמה. |
actionUri |
פלט בלבד. קישור לפעולה הבאה. מחרוזת ריקה אם ההתקנה כבר הושלמה. |
AnnotationsEntry
| ייצוג ב-JSON |
|---|
{ "key": string, "value": string } |
| שדות | |
|---|---|
key |
|
value |
|
CryptoKeyConfig
| ייצוג ב-JSON |
|---|
{ "keyReference": string } |
| שדות | |
|---|---|
keyReference |
חובה. שם המפתח שמשמש להצפנה או לפענוח של נתוני הלקוחות. למפתח ב-Cloud KMS, המפתח צריך להיות בפורמט |
GitProxyConfig
| ייצוג ב-JSON |
|---|
{ "enabled": boolean, "httpProxyBaseUri": string } |
| שדות | |
|---|---|
enabled |
זה שינוי אופציונלי. אם מגדירים את הערך כ-true, אפשר להשתמש בשרת ה-proxy של Git כדי לבצע פעולות Git במאגרים שמקושרים בחיבור. |
httpProxyBaseUri |
פלט בלבד. ה-URI הבסיסי של נקודת הקצה (endpoint) של שרת ה-Proxy ל-HTTP. הפורמט הוא |
GitHubApp
מייצג את האפליקציות השונות של GitHub שאפשר להתקין למשתמש או לארגון ב-GitHub ולהשתמש בהן עם Developer Connect.
| טיפוסים בני מנייה (enum) | |
|---|---|
GIT_HUB_APP_UNSPECIFIED |
לא צוינה אפליקציית GitHub. |
DEVELOPER_CONNECT |
אפליקציית Developer Connect GitHub. |
FIREBASE |
אפליקציית Firebase GitHub. |
GEMINI_CODE_ASSIST |
אפליקציית Gemini Code Assist. |
DATAFORM |
אפליקציית Dataform GitHub. |
שלב
שלב בתהליך ההתקנה.
| טיפוסים בני מנייה (enum) | |
|---|---|
STAGE_UNSPECIFIED |
לא צוין שלב. |
PENDING_CREATE_APP |
רק ל-GitHub Enterprise. נשלחה בקשה ליצירת אפליקציה. המשתמש צריך לאשר את היצירה במארח הארגוני של GitHub. |
PENDING_USER_OAUTH |
המשתמש צריך לאשר את האפליקציה של GitHub (או Enterprise) באמצעות OAuth. |
PENDING_INSTALL_APP |
המשתמש צריך ללחוץ על הקישור כדי להתקין את אפליקציית GitHub (או Enterprise). |
COMPLETE |
תהליך ההתקנה הושלם. |
הערות לגבי הכלים
הערות הכלים נשלחות ללקוחות MCP כדי לתאר את הסיכון הבסיסי של כלי מסוים. רוב הלקוחות מתייחסים לרמזים האלה כלא מהימנים, אבל אפשר להשתמש בהם כדי להחליט מתי לשלוח למשתמש בקשה לאישור.
בנוסף למחרוזת הכותרת, הרמזים הבוליאניים הבאים מוגדרים כך:
-
readOnlyHint: אם הערך הוא True, הכלי לא משנה את הסביבה שלו. ברירת המחדל: false. -
destructiveHint: אם הערך הוא True, הכלי יכול לבצע פעולות הרסניות. אם הערך הוא False, הכלי יכול לבצע רק פעולות הוספה. ברירת המחדל: true. -
idempotentHint: אם הערך הוא True, קריאה חוזרת לכלי עם אותם ארגומנטים לא תשפיע על הסביבה שלו. ברירת המחדל: false. -
openWorldHint: אם הערך הוא True, הכלי יכול לקיים אינטראקציה עם "עולם פתוח" של ישויות חיצוניות. אם הערך הוא false, הכלי יכול לקיים אינטראקציה רק עם ישויות פנימיות. לדוגמה, כלי חיפוש באינטרנט הוא כלי בעולם פתוח, אבל כלי זיכרון הוא לא כלי בעולם פתוח.
Destructive Hint: ❌ | Idempotent Hint: ✅ | Read Only Hint: ✅ | Open World Hint: ❌