跳轉到主要內容
自訂工具透過讓您定義 Claude 在對話期間可以呼叫的自己的函數來擴展 Agent SDK。使用 SDK 的同程序 MCP 伺服器,您可以讓 Claude 存取資料庫、外部 API、特定領域邏輯或應用程式需要的任何其他功能。 本指南涵蓋如何使用輸入結構描述和處理程式定義工具、將它們組合到 MCP 伺服器中、將它們傳遞給 query,以及控制 Claude 可以存取哪些工具。它也涵蓋錯誤處理、工具註解,以及傳回非文字內容(如影像)。

快速參考

建立自訂工具

工具由四個部分定義,作為 TypeScript 中 tool() 協助程式或 Python 中 @tool 裝飾器的引數傳遞:
  • 名稱: Claude 用來呼叫工具的唯一識別碼。
  • 描述: 工具的功能。Claude 讀取此項以決定何時呼叫它。
  • 輸入結構描述: Claude 必須提供的引數。在 TypeScript 中,這始終是 Zod 結構描述,處理程式的 args 會自動從中輸入。在 Python 中,這是將名稱對應到類型的字典,例如 {"latitude": float},SDK 會為您轉換為 JSON Schema。Python 裝飾器也接受完整的 JSON Schema 字典,當您需要列舉、範圍、選用欄位或巢狀物件時。
  • 處理程式: 當 Claude 呼叫工具時執行的非同步函數。它接收驗證的引數,並必須傳回具有以下內容的物件:
    • content(必需):結果區塊的陣列,每個區塊的 type"text""image""audio""resource""resource_link"。請參閱傳回影像和資源以取得非文字區塊。
    • structuredContent(選用):保存結果作為機器可讀資料的 JSON 物件,與 content 一起傳回。請參閱傳回結構化資料
    • isError(選用):設定為 true 以表示工具失敗,讓 Claude 可以對其做出反應。請參閱處理錯誤
定義工具後,使用 createSdkMcpServer(TypeScript)或 create_sdk_mcp_server(Python)將其包裝在伺服器中。伺服器在應用程式內同程序執行,而不是作為單獨的程序。

天氣工具範例

此範例定義 get_temperature 工具並將其包裝在 MCP 伺服器中。它只設定工具;若要將其傳遞至 query 並執行它,請參閱下面的呼叫自訂工具
請參閱 tool() TypeScript 參考或 @tool Python 參考,以取得完整的參數詳細資訊,包括 JSON Schema 輸入格式和傳回值結構。
若要使參數成為選用:在 TypeScript 中,將 .default() 新增至 Zod 欄位。在 Python 中,字典結構描述將每個鍵視為必需,因此請將參數留出結構描述,在描述字串中提及它,並在處理程式中使用 args.get() 讀取它。下面的 get_precipitation_chance 工具顯示兩種模式。

呼叫自訂工具

透過 mcpServers 選項將您建立的 MCP 伺服器傳遞至 querymcpServers 中的鍵成為每個工具的完全限定名稱中的 {server_name} 區段:mcp__{server_name}__{tool_name}。在 allowedTools 中列出該名稱,以便工具執行而不會出現權限提示。 這些程式碼片段重複使用上面範例中的 weatherServer,以詢問 Claude 特定位置的天氣。

新增更多工具

伺服器在其 tools 陣列中列出的工具一樣多。如果有多個工具在伺服器上,您可以在 allowedTools 中個別列出每個工具,或使用萬用字元 mcp__weather__* 來涵蓋伺服器公開的每個工具。 下面的範例將第二個工具 get_precipitation_chance 新增至天氣工具範例中的 weatherServer,並使用陣列中的兩個工具重建它。
此陣列中的每個工具在每個回合都會消耗內容視窗空間。如果您定義了數十個工具,請參閱工具搜尋以改為按需載入它們。

新增工具註解

工具註解是描述工具行為方式的選用中繼資料。在 TypeScript 中將它們作為 tool() 協助程式的第五個引數傳遞,或在 Python 中透過 @tool 裝飾器的 annotations 關鍵字引數傳遞。所有提示欄位都是布林值。 註解是中繼資料,不是強制執行。標記為 readOnlyHint: true 的工具如果處理程式執行該操作,仍然可以寫入磁碟。保持註解準確反映處理程式。 此範例將 readOnlyHint 新增至天氣工具範例中的 get_temperature 工具。
請參閱 TypeScriptPython 參考中的 ToolAnnotations

控制工具存取

天氣工具範例註冊了伺服器並在 allowedTools 中列出了工具。本節涵蓋工具名稱的構造方式,以及當您有多個工具或想要限制內建工具時如何限制存取。

工具名稱格式

當 MCP 工具公開給 Claude 時,它們的名稱遵循特定格式:
  • 模式:mcp__{server_name}__{tool_name}
  • 範例:伺服器 weather 中名為 get_temperature 的工具變成 mcp__weather__get_temperature

設定允許的工具

tools 選項和允許/不允許清單影響兩個層級:可用性控制工具是否出現在 Claude 的內容中,權限控制 Claude 嘗試呼叫後是否核准呼叫。tools 和裸名稱 disallowedTools 項目改變可用性。allowedTools 和限定範圍的 disallowedTools 規則只改變權限。 若要完全移除內建工具,請從 tools 中省略它或在 disallowedTools 中列出其裸名稱(Python:disallowed_tools);兩者都會將工具保留在內容之外,以便 Claude 永遠不會嘗試它。限定範圍的 disallowedTools 規則會阻止符合的呼叫,但會將工具保留為可見,因此 Claude 可能會浪費一個回合嘗試它。請參閱設定權限以取得完整的評估順序。

處理錯誤

處理程式錯誤不會停止代理迴圈。SDK 的同處理程序 MCP 伺服器會捕獲未捕獲的例外,並將其作為錯誤結果傳回,因此您報告錯誤的方式決定了 Claude 讀取的內容,而不是查詢是否失敗: 在兩種情況下,Claude 都可以重試、嘗試不同的工具或解釋失敗。當原始例外訊息不足以讓 Claude 採取行動時,請自行捕獲錯誤。 下面的範例在處理程式內捕獲兩種失敗,並撰寫 Claude 讀取的錯誤訊息。非 200 HTTP 狀態從回應中捕獲並作為錯誤結果傳回。網路錯誤或無效 JSON 由周圍的 try/except(Python)或 try/catch(TypeScript)捕獲,也作為錯誤結果傳回。在兩種情況下,Claude 都會收到描述失敗的訊息,而不是裸露的例外字串。

傳回影像和資源

工具結果中的 content 陣列接受 textimageaudioresourceresource_link 區塊。您可以在同一回應中混合它們。在 TypeScript 中,音訊區塊會儲存到磁碟,Claude 會收到一個包含已儲存檔案路徑的文字區塊;在 Python 中,SDK 會從工具結果中捨棄音訊區塊並記錄警告。資源連結區塊會轉換為包含連結名稱、URI 和描述的文字區塊。

影像

影像區塊以 base64 編碼的方式內聯攜帶影像位元組。沒有 URL 欄位。若要傳回位於 URL 的影像,請在處理程式中擷取它、讀取回應位元組,並在傳回前進行 base64 編碼。結果作為視覺輸入進行處理。

資源

資源區塊嵌入由 URI 識別的內容片段。URI 是 Claude 參考的標籤;實際內容位於區塊的 textblob 欄位中。當您的工具產生稍後按名稱尋址有意義的內容時使用此項,例如生成的檔案或來自外部系統的記錄。 此範例顯示從工具處理程式內傳回的資源區塊。URI file:///tmp/report.md 是 Claude 稍後可以參考的標籤;SDK 不會從該路徑讀取。
這些區塊形狀來自 MCP CallToolResult 類型。請參閱 MCP 規格以取得完整定義。

傳回結構化資料

structuredContent 是結果上的選用 JSON 物件,與 content 陣列分開。使用它傳回原始值,Claude 可以將其讀取為確切欄位,而不是從文字字串或影像中解析它們。 設定 structuredContent 時,Claude 接收 JSON 加上 content 中的任何影像或資源區塊。content 中的文字區塊不會轉發,因為假設它們複製結構化資料。下面的範例將圖表呈現為影像區塊,並從同一處理程式在 structuredContent 中傳回其背後的資料點。
TypeScript
Python @tool 裝飾器僅從處理程式的傳回字典轉發 contentis_error。若要從 Python 傳回 structuredContent,請改為執行獨立 MCP 伺服器

範例:單位轉換器

此工具在長度、溫度和重量的單位之間轉換值。使用者可以詢問「將 100 公里轉換為英里」或「72°F 是多少攝氏度」,Claude 從請求中選擇正確的單位類型和單位。 它演示了兩種模式:
  • 列舉結構描述: unit_type 受限於一組固定值。在 TypeScript 中,使用 z.enum()。在 Python 中,字典結構描述不支援列舉,因此需要完整的 JSON Schema 字典。
  • 不支援的輸入處理: 當找不到轉換對時,處理程式傳回 isError: true,以便 Claude 可以告訴使用者出了什麼問題,而不是將失敗視為正常結果。
定義伺服器後,以與天氣範例相同的方式將其傳遞至 query。此範例在迴圈中傳送三個不同的提示,以顯示同一工具處理不同的單位類型。對於每個回應,它檢查 AssistantMessage 物件(包含 Claude 在該回合期間進行的工具呼叫)並在列印最終 ResultMessage 文字之前列印每個 ToolUseBlock。這讓您看到 Claude 何時使用工具與從自己的知識回答。

後續步驟

自訂工具在標準介面中包裝非同步函數。您可以在同一伺服器中混合本頁上的模式:單一伺服器可以並排保存資料庫工具、API 閘道工具和影像呈現器。 從這裡:
  • 如果您的伺服器增長到數十個工具,請參閱工具搜尋以延遲載入它們,直到 Claude 需要它們。
  • 若要連接到外部 MCP 伺服器(檔案系統、GitHub、Slack)而不是建立自己的,請參閱連接 MCP 伺服器
  • 若要控制哪些工具自動執行與需要核准,請參閱設定權限