連線至 Developer Knowledge MCP 伺服器

Google Developer Knowledge MCP 伺服器可讓 AI 輔助開發工具直接存取及擷取 Firebase、Google Cloud、Android、Google Maps Platform 等產品的官方 Google 開發人員說明文件。將程式碼輔助工具連結至 Google 的權威文件庫,即可避免手動搜尋網頁、使用過時的內容,以及進行網頁擷取。

MCP 伺服器功能

Google Developer Knowledge MCP 伺服器為 AI 程式設計助理提供三項核心工具:

工具名稱 說明
search_documents 搜尋 Google 開發人員說明文件,並傳回最相關的網頁摘錄內容和文件名稱。
get_documents 使用 search_documents 傳回的名稱,擷取文件的完整 Markdown 內容。
answer_query 生成以開發人員知識集為依據的結構化綜合答案。

這項 search_documents 工具會搜尋 Google 的文件,找出與查詢最相關的部分。提問後,這項工具會傳回簡短的文字段落。如果代理程式需要段落周圍的完整網頁內容,可以將文件的資源名稱傳遞至 get_documents,擷取整個網頁。

如果想從開發人員知識語料庫合成問題的直接答案,而非原始搜尋結果或完整 Markdown 檔案,請使用 answer_query 工具。

選擇驗證方法

視開發環境和 AI 助理而定,Developer Knowledge MCP 伺服器支援兩種驗證方法:

  • API 金鑰:最適合第三方 IDE 和 CLI 代理程式,例如 Claude Code、Cursor、GitHub Copilot、Codex 和其他遠端 MCP 用戶端。透過 HTTPS 在 X-Goog-Api-Key 標頭中傳遞 API 金鑰。
  • OAuth 和 ADC:最適合使用應用程式預設憑證 (ADC) 或獨立 OAuth 2.0 用戶端 ID 的 Google Antigravity 或企業工作流程。

產生所選驗證方式所需的憑證,讓 AI 助理或程式設計代理程式透過 Developer Knowledge MCP 伺服器服務驗證要求。

選取分頁來建立憑證:

API 金鑰

必要條件

建立 API 金鑰前,請確認您已完成下列事項:

啟用 API 並建立 API 金鑰

您可以使用 Google Cloud 控制台或 gcloud CLI 產生 API 金鑰:

Google Cloud Console

  1. 在 Google Cloud 控制台中開啟 Developer Knowledge API 頁面
  2. 選取 Google Cloud 雲端專案,然後按一下「啟用」
  3. 前往「Credentials」(憑證) 頁面
  4. 按一下「建立憑證」並選取「API 金鑰」
  5. 按一下「編輯 API 金鑰」動作,設定限制:
    • 在「API 限制」下方,選擇「限制金鑰」
    • 選取「Developer Knowledge API」
    • 如果您打算將這個金鑰用於模型呼叫 (例如 GEMINI_API_KEY),請同時選取「Generative Language API」
  6. 按一下「儲存」,然後複製 API 金鑰。

gcloud CLI

  1. 在專案中啟用 Developer Knowledge API,並將 PROJECT_ID 替換為您的專案 ID:

    gcloud services enable developerknowledge.googleapis.com \
      --project=PROJECT_ID
    
  2. 建立 API 金鑰:

    gcloud services api-keys create \
      --project=PROJECT_ID \
      --display-name="DK API Key"
    

    這項指令會傳回新金鑰的中繼資料詳細資料。從指令輸出內容複製並儲存下列兩個值:

    • keyString:這是原始 API 金鑰 (例如 AIzaSy...)。 您會將這個值貼到 IDE 設定中。
    • name:這是金鑰的資源路徑 (例如 projects/PROJECT_ID/locations/global/keys/UNIQUE_ID)。您會在下一個步驟中使用這個路徑限制金鑰。
  3. 限制金鑰只能用於 Developer Knowledge API,有助於避免未經授權的使用行為。將 KEY_NAME 替換為上一步複製的完整 name 路徑:

    gcloud services api-keys update KEY_NAME \
      --api-target=service=developerknowledge.googleapis.com
    
    gcloud services api-keys update KEY_NAME \
      --api-target=service=developerknowledge.googleapis.com \
      --api-target=service=generativelanguage.googleapis.com
    

OAuth 和 ADC

必要條件

設定 OAuth 前,請確認您具備下列項目:

啟用 API

執行下列指令,在專案中啟用 Developer Knowledge API:

gcloud services enable developerknowledge.googleapis.com \
  --project=PROJECT_ID

選擇 OAuth 憑證類型

選取工具所需的憑證方法:

應用程式預設憑證

如果 AI 助理支援 ADC (例如 Google Antigravity):

  1. 使用 Google 帳戶進行驗證,並設定配額專案:

    gcloud auth application-default login \
      --project=PROJECT_ID
    
  2. 瀏覽器開啟後,請登入 Google 帳戶並授予要求的權限。

OAuth 用戶端 ID

如果 AI 助理需要獨立的 OAuth 用戶端 ID 和密鑰:

  1. 開啟 OAuth 同意畫面
  2. 將使用者類型設為「外部」,填寫必要的應用程式名稱和支援電子郵件,然後按一下「儲存並繼續」
  3. 在「目標對象」頁面中,按一下「測試使用者」下方的「新增使用者」,輸入 Google 電子郵件地址,然後按一下「儲存」
  4. 前往「用戶端」頁面,按一下「建立用戶端」,然後將「應用程式類型」設為「桌面應用程式」
  5. 按一下「建立」,然後下載 JSON 用戶端憑證檔案。

設定 IDE 或程式設計代理

取得憑證後,請選取偏好的程式碼編寫環境,查看設定操作說明。

根據所選的驗證方法,在設定範本中替換預留位置,如下所示:

  • API 金鑰驗證:將 YOUR_API_KEY 替換為原始 API 金鑰字串。
  • OAuth 或 ADC 驗證:將 PROJECT_ID 替換為您的 Google Cloud 雲端專案 ID:

Google Antigravity

Antigravity IDE 和擴充功能

如要在 Antigravity IDE 或 Antigravity 擴充功能 (例如 VS Code) 中設定 MCP 伺服器,請選取驗證方法:

Google 憑證

如要使用一鍵設定安裝 MCP 伺服器,請按照下列步驟操作:

  1. 在「代理程式」面板中,按一下「其他選項」() 選單,然後選取「MCP 伺服器」
  2. 搜尋「Google Developer Knowledge」。
  3. 按一下「安裝」() 圖示。 Antigravity 會自動設定伺服器,並使用您有效的 Google 憑證連線。

API 金鑰

如要在 Antigravity IDE 或 Antigravity 擴充功能中設定 API 金鑰:

  1. 在「代理程式」面板中,依序點選「其他選項」() 選單 >「MCP 伺服器」 >「管理 MCP 伺服器」 >「查看原始設定」(或開啟 .agents/mcp_config.json)。
  2. 新增下列伺服器設定:

    {
      "mcpServers": {
        "google-developer-knowledge": {
          "serverUrl": "https://developerknowledge.googleapis.com/mcp",
          "headers": {
            "X-Goog-Api-Key": "YOUR_API_KEY"
          }
        }
      }
    }
    

Antigravity CLI

在專案的 .agents/mcp_config.json 檔案中設定 MCP 伺服器 (或在 ~/.gemini/config/mcp_config.json 中全域設定):

Google 憑證

{
  "mcpServers": {
    "google-developer-knowledge": {
      "httpUrl": "https://developerknowledge.googleapis.com/mcp",
      "authProviderType": "google_credentials",
      "oauth": {
        "scopes": [
          "https://www.googleapis.com/auth/cloud-platform"
        ]
      },
      "timeout": 30000,
      "headers": {
        "X-goog-user-project": "PROJECT_ID"
      }
    }
  }
}

API 金鑰

{
  "mcpServers": {
    "google-developer-knowledge": {
      "serverUrl": "https://developerknowledge.googleapis.com/mcp",
      "headers": {
        "X-Goog-Api-Key": "YOUR_API_KEY"
      }
    }
  }
}

Claude Code

在終端機中執行下列指令:

claude mcp add google-dev-knowledge \
  --transport http https://developerknowledge.googleapis.com/mcp \
  --header "X-Goog-Api-Key: YOUR_API_KEY"

Cursor

如要設定 Cursor,請在專案根目錄中編輯 .cursor/mcp.json,或編輯 ~/.cursor/mcp.json 以取得全域存取權:

{
  "mcpServers": {
    "google-developer-knowledge": {
      "url": "https://developerknowledge.googleapis.com/mcp",
      "headers": {
        "X-Goog-Api-Key": "YOUR_API_KEY"
      }
    }
  }
}

GitHub Copilot

工作區設定

如要在 VS Code 中為特定工作區設定 GitHub Copilot,請建立或編輯 .vscode/mcp.json

{
  "servers": {
    "google-developer-knowledge": {
      "url": "https://developerknowledge.googleapis.com/mcp",
      "headers": {
        "X-Goog-Api-Key": "YOUR_API_KEY"
      }
    }
  }
}

全域使用者設定

如要讓伺服器在所有 VS Code 工作區中都可使用,請開啟「User Settings (JSON)」,並在 "mcp" 鍵下方新增下列內容:

{
  "mcp": {
    "servers": {
      "google-developer-knowledge": {
        "url": "https://developerknowledge.googleapis.com/mcp",
        "headers": {
          "X-Goog-Api-Key": "YOUR_API_KEY"
        }
      }
    }
  }
}

Codex

如要設定 Codex CLI 或 Codex 代理程式,請將伺服器設定新增至 ~/.codex/config.json (或專案的 .codex/config.json):

{
  "mcpServers": {
    "google-developer-knowledge": {
      "url": "https://developerknowledge.googleapis.com/mcp",
      "headers": {
        "X-Goog-Api-Key": "YOUR_API_KEY"
      }
    }
  }
}

其他

如要設定任何其他遠端 MCP 用戶端 (例如 JetBrains AI Assistant、Windsurf、Cline、Zed、Continue 或 Claude Desktop),請使用下列設定設定 HTTP 傳輸伺服器:

  • 伺服器網址https://developerknowledge.googleapis.com/mcp
  • HTTP 標頭X-Goog-Api-Key: YOUR_API_KEY

標準 JSON 設定範本:

{
  "mcpServers": {
    "google-developer-knowledge": {
      "url": "https://developerknowledge.googleapis.com/mcp",
      "headers": {
        "X-Goog-Api-Key": "YOUR_API_KEY"
      }
    }
  }
}

驗證連線

設定完成後,請重新啟動 AI 助理或重新載入 MCP 伺服器。接著傳送測試提示,確認工具整合功能是否正常運作:

How do I list Cloud Storage buckets using the Google Cloud Python SDK?

如果代理程式叫用 search_documentsanswer_query,並從 Google 文件傳回資訊,表示伺服器已連線並處於啟用狀態。

最佳化脈絡窗口和權杖用量

將完整的文件頁面擷取到 AI 模型的脈絡窗口中,會消耗大量權杖。如果擷取多份大型文件,可能會導致權杖費用高昂、延遲時間增加,以及脈絡窗口溢位。

為確保系統能快速提供經濟實惠的回覆,請遵循下列提示工程最佳做法:

  • 依賴兩步驟擷取: 讓代理程式先呼叫 search_documents。這項功能會傳回重點程式碼片段 (區塊),通常包含您需要的確切語法或 API 簽章,且不會耗用整頁的權杖。指示代理只有在周遭情境絕對必要時,才呼叫 get_documents

  • 概念性問題請使用 answer_query: 需要綜合說明或設計比較時,請指示服務專員使用 answer_query。這項工具會直接從開發人員知識庫彙整答案,不會傳回完整的原始 Markdown 頁面。

  • 撰寫具體且範圍明確的提示: 避免使用範圍過於廣泛的提示,例如「說明所有 Firebase 服務」。請改為指定目標產品、平台和語言:

    How do I write a Firestore transaction in Dart with error handling?
    
  • 新增自訂代理程式規則: 在助理的指令檔案 (例如 .cursorrulesCLAUDE.md.github/copilot-instructions.md) 中新增專案層級的規範, 限制自動擷取完整網頁:

    When searching Google developer documentation, inspect search_documents
    snippets first. Do not call get_documents unless the snippet lacks
    necessary code context.
    

選用的安全防護設定

由於 MCP 工具可執行各種動作,因此會帶來新的安全風險和考量。為盡量降低及管理這些風險,Google Cloud 提供預設設定和可自訂的政策,控管 Google Cloud 機構或專案中 MCP 工具的使用情形。

如要進一步瞭解 MCP 安全性和控管措施,請參閱「AI 安全性」。

使用 Model Armor

Model Armor 是一項 Google Cloud 服務,可以提高 AI 應用程式的安全性。這項功能會主動篩選 LLM 提示詞和回覆,防範各種風險並支援負責任的 AI 做法。無論您是在雲端環境或外部雲端供應商部署 AI,Model Armor 都能協助您防範惡意輸入、驗證內容安全性、保護敏感資料、維持法規遵循狀態,以及在多元的 AI 環境中,持續落實 AI 安全政策。

啟用 Model Armor 並啟用記錄功能後,Model Armor 會記錄整個酬載。這可能會導致記錄中出現私密資訊。

MCP 要求轉送至 Model Armor

Model Armor 僅在特定區域推出。啟用 Model Armor 後,如果您在 Model Armor 不支援的管轄區使用 MCP 伺服器,不同 MCP 伺服器的呼叫路徑行為可能不同,且可能會違反使用中和傳輸中資料的資料落地法規。如要進一步瞭解個別 MCP 伺服器的行為,請參閱「Model Armor 支援的產品」。

啟用 Model Armor

按照「與 Google 和 Google Cloud MCP 伺服器整合」中的步驟啟用 Model Armor。

設定遠端 MCP 伺服器的保護措施

如要保護 MCP 工具呼叫和回應,可以使用 Model Armor 底限設定。底限設定會定義適用於整個專案的最低安全性篩選條件。這項設定會對專案中的所有 MCP 工具呼叫和回覆套用一致的篩選器。

設定 Model Armor 底限設定,並啟用 MCP 清理功能。詳情請參閱「設定 Model Armor 底價」。

請參閱下列指令範例:

gcloud model-armor floorsettings update \
--full-uri='projects/PROJECT_ID/locations/global/floorSetting' \
--enable-floor-setting-enforcement=TRUE \
--add-integrated-services=GOOGLE_MCP_SERVER \
--google-mcp-server-enforcement-type=INSPECT_AND_BLOCK \
--enable-google-mcp-server-cloud-logging \
--malicious-uri-filter-settings-enforcement=ENABLED \
--add-rai-settings-filters='[{"confidenceLevel": "MEDIUM_AND_ABOVE", "filterType": "DANGEROUS"}]'

PROJECT_ID 替換為 專案 ID。

請注意下列設定:

  • INSPECT_AND_BLOCK:強制執行類型,可檢查 Google MCP 伺服器的內容,並封鎖符合篩選條件的提示和回應。
  • ENABLED:啟用篩選器或強制執行的設定。
  • MEDIUM_AND_ABOVE:負責任的 AI 技術 - 危險篩選器設定的信心水準。您可以修改這項設定,但較低的值可能會導致更多誤判。詳情請參閱「Model Armor 信心水準」。

停用使用 Model Armor 掃描 MCP 流量

如要停止 Model Armor 根據專案的底限設定,自動掃描往返 Google MCP 伺服器的流量,請執行下列指令:

gcloud model-armor floorsettings update \
  --full-uri='projects/PROJECT_ID/locations/global/floorSetting' \
  --remove-integrated-services=GOOGLE_MCP_SERVER

PROJECT_ID 替換為 專案 ID。Model Armor 不會自動將這個專案底限設定中定義的規則,套用至任何 Google MCP 伺服器流量。

Model Armor 底限設定和一般設定的影響範圍不只 MCP,由於 Model Armor 會與 Vertex AI 等服務整合,因此您對底限設定所做的任何變更,都會影響所有整合服務 (不只是 MCP) 的流量掃描和安全行為。

調整 Model Armor 設定

如果您使用 Model Armor 保護應用程式,部分查詢可能會發生 403 PERMISSION_DENIED 錯誤。由於 Developer Knowledge MCP 伺服器只會傳回來自可信 Google 來源的公開文件,建議您將提示詞注入和越獄 (PIJB) 篩選器設為 HIGH_AND_ABOVE 可信度等級,以減少誤判。如果您的用途不涉及存取私密或私密資料的其他工具,也可以考慮停用 PIJB 篩選器。

疑難排解

如果無法連線至或查詢 Developer Knowledge MCP 伺服器,請參閱下列疑難排解矩陣和解決步驟:

疑難排解矩陣

症狀或錯誤 可能原因 解析度
400 Bad Request: API key not valid API 金鑰字串遺失、無效或格式錯誤。 確認 API 金鑰已正確複製,並在 headers 物件中以 X-Goog-Api-Key 金鑰設定。
403 PERMISSION_DENIEDDeveloper Knowledge API has not been used Google Cloud 專案未啟用 Developer Knowledge API。 在 Google Cloud 控制台中啟用 API,或執行 gcloud services enable developerknowledge.googleapis.com
403 PERMISSION_DENIED: API target restriction API 金鑰限制清單不包含 Developer Knowledge API。 在 Google Cloud 控制台的「憑證」頁面更新 API 金鑰限制,加入 Developer Knowledge API。
401 UNAUTHENTICATED 或缺少 ADC 憑證 應用程式預設憑證已過期或未初始化。 執行 gcloud auth application-default login --project=PROJECT_ID 以重新整理本機憑證。
403 access_denied / "Access blocked: authorization error" 您的帳戶未列為 OAuth 同意畫面中的授權測試使用者。 Google Cloud 控制台中,依序點選「Auth Platform」>「Audience」,然後在「Test users」下方新增電子郵件地址。
OAuth 用戶端錯誤或無效的重新導向 URI OAuth 用戶端是使用不支援的應用程式類型建立。 重新建立 OAuth 用戶端 ID,並將類型設為「桌面應用程式」
404 NOT_FOUND 個端點/mcp 專案未啟用 API。 在 Google Cloud 控制台中啟用 Developer Knowledge API,或執行 gcloud services enable developerknowledge.googleapis.com
429 RESOURCE_EXHAUSTED 您已達到專案的配額上限。 在控制台中查看 Developer Knowledge API 配額用量,並視需要申請提高配額。
403 PERMISSION_DENIED 使用 Model Armor Model Armor PIJB 篩選器誤判為偽陽性,封鎖了安全查詢。 在 Model Armor 範本設定中,將 PIJB 篩選器信心水準設為 HIGH_AND_ABOVE

解決驗證和同意聲明錯誤

  • API 金鑰標頭設定: 確認 MCP JSON 設定包含 headers 區段和 "X-Goog-Api-Key"。請勿在網址中將 API 金鑰做為查詢參數傳遞。

  • OAuth 同意畫面測試使用者: 在測試模式下,如果專案中建立的 OAuth 用戶端含有外部使用者類型,Google 會封鎖未列在測試使用者下的帳戶存取權。請確認您已在 Google Cloud 控制台的「目標對象」 >「測試使用者」下方,新增有效的 Google 電子郵件地址。

  • 配額和速率限制: 如要監控每日和每分鐘用量,請前往 Google Cloud 控制台的「IAM & Admin」(IAM 與管理) >「Quotas & System Limits」(配額與系統限制),然後依「Developer Knowledge API」篩選。

隨附文件

如需伺服器建立索引的 Google 產品和說明文件存放區完整清單,請參閱主體參考資料

已知限制

  • 僅限公開文件:伺服器只會為語料庫參考資料中列出的公開文件建立索引。不包括內部文件、私人存放區和第三方資源。
  • 英文:伺服器只會為英文文件建立索引並傳回。
  • 網路依附元件:伺服器必須連上網際網路,才能連線至 https://developerknowledge.googleapis.com