SpyBara
Go Premium

agent-sdk/custom-tools.md 2026-09-17 05:00 UTC to 2026-09-18 23:58 UTC

This page contains 1 addition and 1 deletion.

2026
Thu 10 23:00 Fri 18 23:58

為 Claude 提供自訂工具

使用 Claude Agent SDK 的同程序 MCP 伺服器定義自訂工具,讓 Claude 可以呼叫您的函數、存取您的 API,並執行特定領域的操作。

自訂工具透過讓您定義 Claude 在對話期間可以呼叫的自己的函數來擴展 Agent SDK。使用 SDK 的同程序 MCP 伺服器,您可以讓 Claude 存取資料庫、外部 API、特定領域邏輯或應用程式需要的任何其他功能。

快速參考

如果您想要... 執行此操作
定義工具 使用 @tool(Python)或 tool()(TypeScript),搭配名稱、描述、結構描述和處理程式。請參閱建立自訂工具。
向 Claude 註冊工具 在 create_sdk_mcp_server / createSdkMcpServer 中包裝,並傳遞至 query() 中的 mcpServers。請參閱呼叫自訂工具。
預先核准工具 新增至您允許的工具。請參閱設定允許的工具。
從 Claude 的內容中移除內建工具 傳遞 tools 陣列,僅列出您想要的內建工具。請參閱設定允許的工具。
讓 Claude 平行呼叫工具 在沒有副作用的工具上設定 readOnlyHint: true。請參閱新增工具註解。
控制 Claude 讀取的錯誤訊息 傳回 isError: true 以組成訊息,而不是顯示原始例外狀況。請參閱處理錯誤。
傳回影像或檔案 在內容陣列中使用 image 或 resource 區塊。請參閱傳回影像和資源。
傳回機器可讀的 JSON 結果 在結果上設定 structuredContent。請參閱傳回結構化資料。
擴展到許多工具 使用工具搜尋按需載入工具。

建立自訂工具

工具由四個部分定義,作為引數傳遞給 TypeScript 中的 tool() 輔助函式或 Python 中的 @tool 裝飾器:

  • 名稱: Claude 用來呼叫工具的唯一識別碼。
  • 描述: 工具的功能。Claude 讀取此項以決定何時呼叫它。
  • 輸入綱要: Claude 必須提供的引數。在 TypeScript 中,這始終是 Zod 綱要,處理程式的 args 會自動從中輸入。在 Python 中,這是將名稱對應到類型的字典,例如 {"latitude": float},SDK 會為您將其轉換為 JSON 綱要。Python 裝飾器也接受完整的 JSON 綱要字典,當您需要列舉、範圍、選用欄位或巢狀物件時。
  • 處理程式: 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 並執行它,請參閱下面的呼叫自訂工具。

from typing import Any
import httpx
from claude_agent_sdk import tool, create_sdk_mcp_server


# Define a tool: name, description, input schema, handler
@tool(
"get_temperature",
"Get the current temperature at a location",
{"latitude": float, "longitude": float},
)
async def get_temperature(args: dict[str, Any]) -> dict[str, Any]:
async with httpx.AsyncClient() as client:
response = await client.get(
"https://api.open-meteo.com/v1/forecast",
params={
"latitude": args["latitude"],
"longitude": args["longitude"],
"current": "temperature_2m",
"temperature_unit": "fahrenheit",
},
)
data = response.json()

# Return a content array - Claude sees this as the tool result
return {
"content": [
{
"type": "text",
"text": f"Temperature: {data['current']['temperature_2m']}°F",
}
]
}


# Wrap the tool in an in-process MCP server
weather_server = create_sdk_mcp_server(
name="weather",
version="1.0.0",
tools=[get_temperature],
)

請參閱 tool() TypeScript 參考或 @tool Python 參考以取得完整的參數詳細資訊,包括 JSON 綱要輸入格式和傳回值結構。

呼叫自訂工具

透過 mcpServers 選項將您建立的 MCP 伺服器傳遞給 query。mcpServers 中的鍵成為每個工具的完全限定名稱中的 {server_name} 區段:mcp__{server_name}__{tool_name}。在 allowedTools 中列出該名稱,以便工具執行而不會出現權限提示。

這些程式碼片段重複使用天氣工具範例中的 weatherServer 來詢問 Claude 特定位置的天氣。

import asyncio
from claude_agent_sdk import query, ClaudeAgentOptions, ResultMessage


async def main():
options = ClaudeAgentOptions(
mcp_servers={"weather": weather_server},
allowed_tools=["mcp__weather__get_temperature"],
)

async for message in query(
prompt="What's the temperature in San Francisco?",
options=options,
):
# ResultMessage is the final message after all tool calls complete
if isinstance(message, ResultMessage) and message.subtype == "success":
print(message.result)


asyncio.run(main())

將此程式碼片段與天氣工具範例中的工具和伺服器定義結合在一個檔案中,然後使用 python weather.py(Python)或 npx tsx weather.ts(TypeScript)執行它。Claude 呼叫 get_temperature,指令碼會列印一行答案,顯示舊金山目前的溫度。

新增更多工具

伺服器在其 tools 陣列中列出的工具數量不限。當伺服器上有多個工具時,您可以在 allowedTools 中個別列出每個工具,或使用萬用字元 mcp__weather__* 來涵蓋伺服器公開的每個工具。

下面的範例定義第二個工具 get_precipitation_chance,並將天氣工具範例中的 weatherServer 定義替換為在陣列中列出兩個工具的定義。

# Define a second tool for the same server
@tool(
"get_precipitation_chance",
"Get the hourly precipitation probability for a location. "
"Optionally pass 'hours' (1-24) to control how many hours to return.",
{"latitude": float, "longitude": float},
)
async def get_precipitation_chance(args: dict[str, Any]) -> dict[str, Any]:
# 'hours' isn't in the schema - read it with .get() to make it optional
hours = args.get("hours", 12)
async with httpx.AsyncClient() as client:
response = await client.get(
"https://api.open-meteo.com/v1/forecast",
params={
"latitude": args["latitude"],
"longitude": args["longitude"],
"hourly": "precipitation_probability",
"forecast_days": 1,
},
)
data = response.json()
chances = data["hourly"]["precipitation_probability"][:hours]

return {
"content": [
{
"type": "text",
"text": f"Next {hours} hours: {'%, '.join(map(str, chances))}%",
}
]
}


# Rebuild the server with both tools in the array
weather_server = create_sdk_mcp_server(
name="weather",
version="1.0.0",
tools=[get_temperature, get_precipitation_chance],
)

工具搜尋預設為開啟,並延遲 SDK MCP 工具:Claude 在精簡清單中看到每個工具的名稱,並按需載入其完整綱要。停用工具搜尋後,此陣列中的每個工具在每個回合都會消耗內容視窗空間。在 TypeScript 中,在 tool() 的 extras 引數或 createSdkMcpServer() 的選項中傳遞 alwaysLoad: true,以在初始提示中保留工具的完整綱要。

新增工具註釋

工具註釋是描述工具行為方式的選用中繼資料。在 TypeScript 中將它們作為 tool() 輔助函式的第五個引數傳遞,或在 Python 中透過 @tool 裝飾器的 annotations 關鍵字引數傳遞。所有提示欄位都是布林值。

欄位 預設 意義
readOnlyHint false 工具不會修改其環境。控制工具是否可以與其他唯讀工具並行呼叫。
destructiveHint true 工具可能執行破壞性更新。僅供參考。
idempotentHint false 使用相同引數重複呼叫沒有額外效果。僅供參考。
openWorldHint true 工具到達您程序外的系統。僅供參考。

註釋是中繼資料,不是強制執行。標記為 readOnlyHint: true 的工具如果處理程式執行該操作,仍然可以寫入磁碟。保持註釋與處理程式準確。

此範例將 readOnlyHint 新增至天氣工具範例中的 get_temperature 工具。

from claude_agent_sdk import tool, ToolAnnotations


@tool(
"get_temperature",
"Get the current temperature at a location",
{"latitude": float, "longitude": float},
annotations=ToolAnnotations(
readOnlyHint=True
),  # Lets Claude batch this with other read-only calls
)
async def get_temperature(args):
return {"content": [{"type": "text", "text": "..."}]}

請參閱 TypeScript 或 Python 參考中的 ToolAnnotations。

控制工具存取

天氣工具範例註冊了伺服器並在 allowedTools 中列出工具。本節涵蓋當您有多個工具或想要限制內建工具時如何限制存取範圍。如需了解工具名稱的構成方式,請參閱呼叫自訂工具。

設定允許的工具

tools 選項和允許/不允許清單會影響兩個層級:可用性(控制工具是否出現在 Claude 的上下文中)和權限(控制 Claude 嘗試呼叫後是否獲得批准)。tools 和裸名稱 disallowedTools 項目會變更可用性。allowedTools 和限定範圍的 disallowedTools 規則會變更權限。如果您在 allowedTools 中命名其中一個任務追蹤工具,Claude Code 也會選擇加入工作階段。

選項 層級 效果
tools: ["Read", "Grep"] 可用性 只有列出的內建工具在 Claude 的上下文中。未列出的內建工具會被移除。MCP 工具不受影響。
tools: [] 可用性 所有內建工具都會被移除。Claude 只能使用您的 MCP 工具。
允許的工具 權限 列出的工具無需權限提示即可執行。其他未列出的工具仍然可用;呼叫會通過權限流程。
不允許的工具 兩者 裸工具名稱(例如 "Bash")會從 Claude 的上下文中移除工具,與從 tools 中省略它的效果相同。限定範圍的規則(例如 "Bash(rm *)")會將工具保留在上下文中,並僅拒絕與如所寫相符的呼叫。

若要完全移除內建工具,請從 tools 中省略它或在 disallowedTools 中列出其裸名稱(Python:disallowed_tools);兩者都會將工具保留在上下文之外,以便 Claude 永遠不會嘗試它。限定範圍的 disallowedTools 規則會阻止相符的呼叫,但將工具保留為可見,因此 Claude 可能會浪費一個回合嘗試它。如需完整的評估順序,請參閱設定權限。

處理錯誤

處理程式錯誤不會停止代理迴圈。SDK 的同處理程序 MCP 伺服器會捕捉未捕捉的例外狀況,並將其作為錯誤結果返回,因此您報告錯誤的方式決定了 Claude 讀取的內容,而不是查詢是否失敗:

發生的情況 結果
處理程式拋出未捕捉的例外狀況 MCP 伺服器將其轉換為攜帶原始例外狀況訊息的錯誤結果。Claude 看到該訊息,代理迴圈繼續。
處理程式捕捉錯誤並返回 isError: true (TS) / "is_error": True (Python) Claude 看到您撰寫的訊息。您可以添加原始例外狀況缺乏的背景資訊,例如哪個請求失敗或應該嘗試什麼。

在這兩種情況下,Claude 都可以重試、嘗試不同的工具或解釋失敗。當原始例外狀況訊息不足以讓 Claude 採取行動時,請自行捕捉錯誤。

下面的範例在處理程式內捕捉兩種失敗,並撰寫 Claude 讀取的錯誤訊息。非 200 HTTP 狀態碼從回應中捕捉並作為錯誤結果返回。網路錯誤或無效的 JSON 由周圍的 try/except (Python) 或 try/catch (TypeScript) 捕捉,也作為錯誤結果返回。在這兩種情況下,Claude 都會收到描述失敗的訊息,而不是裸露的例外狀況字串。

import json
import httpx
from typing import Any
from claude_agent_sdk import tool


@tool(
"fetch_data",
"Fetch data from an API",
{"endpoint": str},  # Simple schema
)
async def fetch_data(args: dict[str, Any]) -> dict[str, Any]:
try:
async with httpx.AsyncClient() as client:
response = await client.get(args["endpoint"])
if response.status_code != 200:
# Return the failure as a tool result so Claude can react to it.
# is_error marks this as a failed call rather than odd-looking data.
return {
"content": [
{
"type": "text",
"text": f"API error: {response.status_code} {response.reason_phrase}",
}
],
"is_error": True,
}

data = response.json()
return {"content": [{"type": "text", "text": json.dumps(data, indent=2)}]}
except Exception as e:
# Composes the message Claude reads. An uncaught exception would
# reach Claude as the raw str(e) with no context.
return {
"content": [{"type": "text", "text": f"Failed to fetch data: {str(e)}"}],
"is_error": True,
}

返回影像和資源

工具結果中的 content 陣列接受 text、image、audio、resource 和 resource_link 區塊。您可以在同一個回應中混合使用它們。在 TypeScript 中,SDK 會將音訊區塊儲存到磁碟,Claude 會收到一個包含已儲存檔案路徑的文字區塊;在 Python 中,SDK 會從工具結果中移除音訊區塊並記錄警告。

Claude 會將每個資源連結區塊作為文字區塊接收,其中包含連結的名稱、URI 和描述。在 TypeScript 中,您的應用程式也會在使用者訊息的 tool_use_result 上以 resourceLinks 的形式接收連結本身;在 Python 中,SDK 會在 CLI 看到結果之前將它們扁平化為文字,因此 Python resourceLinks 鍵 永遠不會針對程序內工具產生。

影像

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

欄位 類型 備註
type "image"
data string Base64 編碼的位元組。僅限原始 base64,沒有 data:image/...;base64, 前綴
mimeType string 必需。例如 image/png、image/jpeg、image/webp、image/gif
import base64
import httpx
from claude_agent_sdk import tool


# Define a tool that fetches an image from a URL and returns it to Claude
@tool("fetch_image", "Fetch an image from a URL and return it to Claude", {"url": str})
async def fetch_image(args):
async with httpx.AsyncClient() as client:  # Fetch the image bytes
response = await client.get(args["url"])

return {
"content": [
{
"type": "image",
"data": base64.b64encode(response.content).decode(
"ascii"
),  # Base64-encode the raw bytes
"mimeType": response.headers.get(
"content-type", "image/png"
),  # Read MIME type from the response
}
]
}

資源

資源區塊嵌入由 URI 識別的內容片段。URI 是 Claude 稍後參考的標籤;實際內容位於區塊的 text 或 blob 欄位中。當您的工具產生的內容稍後按名稱尋址時使用此功能,例如產生的檔案或來自外部系統的記錄。

欄位 類型 備註
type "resource"
resource.uri string 內容的識別碼。任何 URI 配置
resource.text string 內容(如果是文字)。提供此項或 blob,但不能同時提供兩者
resource.blob string 內容 base64 編碼(如果是二進位)。僅限 TypeScript:Python SDK 會從工具結果中移除二進位資源並記錄警告
resource.mimeType string 選用

此範例顯示從工具處理程式內部返回的資源區塊。URI file:///tmp/report.md 是 Claude 稍後可以參考的標籤;SDK 不會從該路徑讀取。

return {
content: [
{
type: "resource",
resource: {
uri: "file:///tmp/report.md", // Label for Claude to reference, not a path the SDK reads
mimeType: "text/markdown",
text: "# Report\n..." // The actual content, inline
}
}
]
};

這些區塊形狀來自 MCP CallToolResult 類型。請參閱 MCP 規格 以取得完整定義。

返回結構化資料

structuredContent 是結果上的選用 JSON 物件,與 content 陣列分開。使用它來返回原始值,Claude 可以將其讀取為確切的欄位,而不是從文字字串或影像中解析它們。

當設定 structuredContent 時,Claude 會收到 JSON 加上來自 content 的任何影像或資源區塊。content 中的文字區塊不會被轉發,因為假設它們會複製結構化資料。下面的範例將圖表呈現為影像區塊,並從同一個處理程式的 structuredContent 中返回其背後的資料點。在程式碼片段中,chartPngBuffer 是一個包含已呈現 PNG 位元組的 Buffer。

return {
  content: [
    {
      type: "image",
      data: chartPngBuffer.toString("base64"),
      mimeType: "image/png"
    }
  ],
  structuredContent: {
    series: "temperature_2m",
    unit: "fahrenheit",
    points: [62.1, 63.4, 65.0, 64.2]
  }
};

範例:單位轉換器

此工具在長度、溫度和重量的單位之間轉換數值。使用者可以詢問「將 100 公里轉換為英里」或「72°F 是多少攝氏度」,Claude 會從請求中選擇正確的單位類型和單位。

它展示了兩種模式:

  • Enum schemas: unit_type 受限於一組固定值。在 TypeScript 中,使用 z.enum()。在 Python 中,dict schema 不支援 enum,因此需要完整的 JSON Schema dict。
  • 不支援的輸入處理: 當找不到轉換對時,處理程式會傳回 isError: true,以便 Claude 可以告訴使用者出了什麼問題,而不是將失敗視為正常結果。
from typing import Any
from claude_agent_sdk import tool, create_sdk_mcp_server


# z.enum() in TypeScript becomes an "enum" constraint in JSON Schema.
# The dict schema has no equivalent, so full JSON Schema is required.
@tool(
"convert_units",
"Convert a value from one unit to another",
{
"type": "object",
"properties": {
"unit_type": {
"type": "string",
"enum": ["length", "temperature", "weight"],
"description": "Category of unit",
},
"from_unit": {
"type": "string",
"description": "Unit to convert from, e.g. kilometers, fahrenheit, pounds",
},
"to_unit": {"type": "string", "description": "Unit to convert to"},
"value": {"type": "number", "description": "Value to convert"},
},
"required": ["unit_type", "from_unit", "to_unit", "value"],
},
)
async def convert_units(args: dict[str, Any]) -> dict[str, Any]:
conversions = {
"length": {
"kilometers_to_miles": lambda v: v * 0.621371,
"miles_to_kilometers": lambda v: v * 1.60934,
"meters_to_feet": lambda v: v * 3.28084,
"feet_to_meters": lambda v: v * 0.3048,
},
"temperature": {
"celsius_to_fahrenheit": lambda v: (v * 9) / 5 + 32,
"fahrenheit_to_celsius": lambda v: (v - 32) * 5 / 9,
"celsius_to_kelvin": lambda v: v + 273.15,
"kelvin_to_celsius": lambda v: v - 273.15,
},
"weight": {
"kilograms_to_pounds": lambda v: v * 2.20462,
"pounds_to_kilograms": lambda v: v * 0.453592,
"grams_to_ounces": lambda v: v * 0.035274,
"ounces_to_grams": lambda v: v * 28.3495,
},
}

key = f"{args['from_unit']}_to_{args['to_unit']}"
fn = conversions.get(args["unit_type"], {}).get(key)

if not fn:
return {
"content": [
{
"type": "text",
"text": f"Unsupported conversion: {args['from_unit']} to {args['to_unit']}",
}
],
"is_error": True,
}

result = fn(args["value"])
return {
"content": [
{
"type": "text",
"text": f"{args['value']} {args['from_unit']} = {result:.4f} {args['to_unit']}",
}
]
}


converter_server = create_sdk_mcp_server(
name="converter",
version="1.0.0",
tools=[convert_units],
)

伺服器定義後,以與天氣範例相同的方式將其傳遞給 query。此範例在迴圈中發送三個不同的提示,以展示相同的工具處理不同的單位類型。對於每個回應,它檢查 AssistantMessage 物件(包含該輪中 Claude 進行的工具呼叫)並在列印最終 ResultMessage 文字之前列印每個 ToolUseBlock。這讓您可以看到 Claude 何時使用工具與何時從自己的知識回答。

因為 tool search 預設為開啟,輸出也可能包含 ToolSearch 呼叫,因為 Claude 載入延遲的工具 schema。

import asyncio
from claude_agent_sdk import (
query,
ClaudeAgentOptions,
ResultMessage,
AssistantMessage,
ToolUseBlock,
)


async def main():
options = ClaudeAgentOptions(
mcp_servers={"converter": converter_server},
allowed_tools=["mcp__converter__convert_units"],
)

prompts = [
"Convert 100 kilometers to miles.",
"What is 72°F in Celsius?",
"How many pounds is 5 kilograms?",
]

for prompt in prompts:
try:
async for message in query(prompt=prompt, options=options):
if isinstance(message, AssistantMessage):
for block in message.content:
if isinstance(block, ToolUseBlock):
print(f"[tool call] {block.name}({block.input})")
elif isinstance(message, ResultMessage) and message.subtype == "success":
print(f"Q: {prompt}\nA: {message.result}\n")
except Exception as error:
# A single-shot query() raises after yielding an error result. Only success
# results are printed above, so handle the failure here and continue with
# the next prompt.
print(f"Call failed: {error}")


asyncio.run(main())

後續步驟

您可以在同一個伺服器上混合使用本頁面的模式:單一伺服器可以同時包含資料庫工具、API 閘道工具和影像渲染器。

從這裡開始:

  • 如果您的伺服器增長到數十個工具,請參閱工具搜尋以延遲載入它們,直到 Claude 需要它們為止。
  • 若要連接到外部 MCP 伺服器(檔案系統、GitHub、Slack)而不是建立您自己的伺服器,請參閱連接 MCP 伺服器。
  • 若要控制哪些工具自動執行與需要核准,請參閱設定權限。