Vai al contenuto principale
Gli strumenti personalizzati estendono l’Agent SDK permettendoti di definire le tue funzioni che Claude può chiamare durante una conversazione. Utilizzando il server MCP in-process dell’SDK, puoi dare a Claude accesso a database, API esterne, logica specifica del dominio o qualsiasi altra capacità di cui la tua applicazione ha bisogno. Questa guida copre come definire strumenti con schemi di input e handler, raggrupparli in un server MCP, passarli a query e controllare a quali strumenti Claude può accedere. Copre anche la gestione degli errori, le annotazioni degli strumenti e la restituzione di contenuti non testuali come immagini.

Riferimento rapido

Se vuoi…Fai questo
Definire uno strumentoUsa @tool (Python) o tool() (TypeScript) con un nome, una descrizione, uno schema e un handler. Vedi Creare uno strumento personalizzato.
Registrare uno strumento con ClaudeAvvolgi in create_sdk_mcp_server / createSdkMcpServer e passa a mcpServers in query(). Vedi Chiamare uno strumento personalizzato.
Pre-approvare uno strumentoAggiungi ai tuoi strumenti consentiti. Vedi Configurare gli strumenti consentiti.
Rimuovere uno strumento integrato dal contesto di ClaudePassa un array tools elencando solo gli strumenti integrati che desideri. Vedi Configurare gli strumenti consentiti.
Permettere a Claude di chiamare strumenti in paralleloImposta readOnlyHint: true su strumenti senza effetti collaterali. Vedi Aggiungere annotazioni degli strumenti.
Gestire gli errori senza interrompere il cicloRestituisci isError: true invece di lanciare un’eccezione. Vedi Gestire gli errori.
Restituire immagini o fileUsa blocchi image o resource nell’array di contenuti. Vedi Restituire immagini e risorse.
Restituire un risultato JSON leggibile da macchinaImposta structuredContent sul risultato. Vedi Restituire dati strutturati.
Scalare a molti strumentiUsa tool search per caricare gli strumenti su richiesta.

Creare uno strumento personalizzato

Uno strumento è definito da quattro parti, passate come argomenti al helper tool() in TypeScript o al decoratore @tool in Python:
  • Nome: un identificatore univoco che Claude usa per chiamare lo strumento.
  • Descrizione: cosa fa lo strumento. Claude legge questo per decidere quando chiamarlo.
  • Schema di input: gli argomenti che Claude deve fornire. In TypeScript questo è sempre uno schema Zod, e gli args dell’handler sono tipizzati automaticamente da esso. In Python questo è un dict che mappa nomi a tipi, come {"latitude": float}, che l’SDK converte in JSON Schema per te. Il decoratore Python accetta anche un dict completo di JSON Schema direttamente quando hai bisogno di enum, intervalli, campi opzionali o oggetti annidati.
  • Handler: la funzione asincrona che viene eseguita quando Claude chiama lo strumento. Riceve gli argomenti convalidati e deve restituire un oggetto con:
    • content (obbligatorio): un array di blocchi di risultato, ognuno con un type di "text", "image" o "resource". Vedi Restituire immagini e risorse per blocchi non testuali.
    • structuredContent (opzionale): un oggetto JSON che contiene il risultato come dati leggibili da macchina, restituito insieme a content. Vedi Restituire dati strutturati.
    • isError (opzionale): imposta su true per segnalare un fallimento dello strumento in modo che Claude possa reagire. Vedi Gestire gli errori.
Dopo aver definito uno strumento, avvolgilo in un server con createSdkMcpServer (TypeScript) o create_sdk_mcp_server (Python). Il server viene eseguito in-process all’interno della tua applicazione, non come processo separato.

Esempio di strumento meteo

Questo esempio definisce uno strumento get_temperature e lo avvolge in un server MCP. Configura solo lo strumento; per passarlo a query e eseguirlo, vedi Chiamare uno strumento personalizzato di seguito.
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],
)
Vedi il riferimento TypeScript tool() o il riferimento Python @tool per i dettagli completi dei parametri, inclusi i formati di input JSON Schema e la struttura del valore di ritorno.
Per rendere un parametro opzionale: in TypeScript, aggiungi .default() al campo Zod. In Python, lo schema dict tratta ogni chiave come obbligatoria, quindi ometti il parametro dallo schema, menzionalo nella stringa di descrizione e leggilo con args.get() nell’handler. Lo strumento get_precipitation_chance di seguito mostra entrambi i pattern.

Chiamare uno strumento personalizzato

Passa il server MCP che hai creato a query tramite l’opzione mcpServers. La chiave in mcpServers diventa il segmento {server_name} nel nome completamente qualificato di ogni strumento: mcp__{server_name}__{tool_name}. Elenca quel nome in allowedTools in modo che lo strumento venga eseguito senza un prompt di autorizzazione. Questi snippet riutilizzano il weatherServer dall’esempio precedente per chiedere a Claude qual è il meteo in una posizione specifica.
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())

Aggiungere più strumenti

Un server contiene quanti strumenti elenchi nel suo array tools. Con più di uno strumento su un server, puoi elencare ognuno in allowedTools individualmente o usare il wildcard mcp__weather__* per coprire ogni strumento che il server espone. L’esempio di seguito aggiunge un secondo strumento, get_precipitation_chance, al weatherServer dall’esempio di strumento meteo e lo ricostruisce con entrambi gli strumenti nell’array.
# 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],
)
Ogni strumento in questo array consuma spazio della finestra di contesto ad ogni turno. Se stai definendo dozzine di strumenti, vedi tool search per caricarli su richiesta invece.

Aggiungere annotazioni degli strumenti

Le annotazioni degli strumenti sono metadati opzionali che descrivono come si comporta uno strumento. Passali come quinto argomento al helper tool() in TypeScript o tramite l’argomento della parola chiave annotations per il decoratore @tool in Python. Tutti i campi hint sono booleani.
CampoPredefinitoSignificato
readOnlyHintfalseLo strumento non modifica il suo ambiente. Controlla se lo strumento può essere chiamato in parallelo con altri strumenti di sola lettura.
destructiveHinttrueLo strumento può eseguire aggiornamenti distruttivi. Solo informativo.
idempotentHintfalseLe chiamate ripetute con gli stessi argomenti non hanno effetti aggiuntivi. Solo informativo.
openWorldHinttrueLo strumento raggiunge sistemi al di fuori del tuo processo. Solo informativo.
Le annotazioni sono metadati, non applicazione. Uno strumento contrassegnato con readOnlyHint: true può comunque scrivere su disco se è quello che fa l’handler. Mantieni l’annotazione accurata rispetto all’handler. Questo esempio aggiunge readOnlyHint allo strumento get_temperature dall’esempio di strumento meteo.
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": "..."}]}
Vedi ToolAnnotations nel riferimento TypeScript o Python.

Controllare l’accesso agli strumenti

L’esempio di strumento meteo ha registrato un server e elencato gli strumenti in allowedTools. Questa sezione copre come vengono costruiti i nomi degli strumenti e come limitare l’accesso quando hai più strumenti o vuoi limitare gli strumenti integrati.

Formato del nome dello strumento

Quando gli strumenti MCP vengono esposti a Claude, i loro nomi seguono un formato specifico:
  • Pattern: mcp__{server_name}__{tool_name}
  • Esempio: Uno strumento denominato get_temperature nel server weather diventa mcp__weather__get_temperature

Configurare gli strumenti consentiti

L’opzione tools e gli elenchi consentiti/non consentiti influiscono su due livelli: la disponibilità, che controlla se uno strumento appare nel contesto di Claude, e l’autorizzazione, che controlla se una chiamata viene approvata una volta che Claude tenta di farla. tools e le voci disallowedTools con nome semplice cambiano la disponibilità. allowedTools e le regole disallowedTools con ambito cambiano solo l’autorizzazione.
OpzioneLivelloEffetto
tools: ["Read", "Grep"]DisponibilitàSolo gli strumenti integrati elencati sono nel contesto di Claude. Gli strumenti integrati non elencati vengono rimossi. Gli strumenti MCP non sono interessati.
tools: []DisponibilitàTutti gli strumenti integrati vengono rimossi. Claude può usare solo i tuoi strumenti MCP.
strumenti consentitiAutorizzazioneGli strumenti elencati vengono eseguiti senza un prompt di autorizzazione. Gli strumenti non elencati rimangono disponibili; le chiamate passano attraverso il flusso di autorizzazione.
strumenti non consentitiEntrambiUn nome di strumento semplice come "Bash" rimuove lo strumento dal contesto di Claude, come se lo omettessi da tools. Una regola con ambito come "Bash(rm *)" lascia lo strumento nel contesto e nega solo le chiamate corrispondenti.
Per rimuovere completamente uno strumento integrato, omettilo da tools o elencane il nome semplice in disallowedTools (Python: disallowed_tools); entrambi mantengono lo strumento fuori dal contesto in modo che Claude non lo tenti mai. Una regola disallowedTools con ambito blocca le chiamate corrispondenti ma lascia lo strumento visibile, quindi Claude potrebbe sprecare un turno tentandolo. Vedi Configurare le autorizzazioni per l’ordine di valutazione completo.

Gestire gli errori

Come il tuo handler segnala gli errori determina se il ciclo dell’agente continua o si ferma:
Cosa succedeRisultato
L’handler lancia un’eccezione non catturataIl ciclo dell’agente si ferma. Claude non vede mai l’errore e la chiamata query fallisce.
L’handler cattura l’errore e restituisce isError: true (TS) / "is_error": True (Python)Il ciclo dell’agente continua. Claude vede l’errore come dati e può riprovare, provare uno strumento diverso o spiegare il fallimento.
L’esempio di seguito cattura due tipi di fallimenti all’interno dell’handler invece di lasciarli lanciare. Uno stato HTTP non-200 viene catturato dalla risposta e restituito come risultato di errore. Un errore di rete o JSON non valido viene catturato dal try/except (Python) o try/catch (TypeScript) circostante e viene anche restituito come risultato di errore. In entrambi i casi l’handler restituisce normalmente e il ciclo dell’agente continua.
import json
import httpx
from typing import Any


@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:
        # Catching here keeps the agent loop alive. An uncaught exception
        # would end the whole query() call.
        return {
            "content": [{"type": "text", "text": f"Failed to fetch data: {str(e)}"}],
            "is_error": True,
        }

Restituire immagini e risorse

L’array content in un risultato dello strumento accetta blocchi text, image e resource. Puoi mischiarli nella stessa risposta.

Immagini

Un blocco immagine trasporta i byte dell’immagine inline, codificati come base64. Non c’è campo URL. Per restituire un’immagine che si trova in un URL, recuperala nell’handler, leggi i byte della risposta e codificali in base64 prima di restituire. Il risultato viene elaborato come input visivo.
CampoTipoNote
type"image"
datastringByte codificati in base64. Solo base64 grezzo, nessun prefisso data:image/...;base64,
mimeTypestringObbligatorio. Ad esempio image/png, image/jpeg, image/webp, image/gif
import base64
import httpx


# 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
            }
        ]
    }

Risorse

Un blocco risorsa incorpora un pezzo di contenuto identificato da un URI. L’URI è un’etichetta per Claude da riferire; il contenuto effettivo si trova nel campo text o blob del blocco. Usa questo quando il tuo strumento produce qualcosa che ha senso affrontare per nome in seguito, come un file generato o un record da un sistema esterno.
CampoTipoNote
type"resource"
resource.uristringIdentificatore per il contenuto. Qualsiasi schema URI
resource.textstringIl contenuto, se è testo. Fornisci questo o blob, non entrambi
resource.blobstringIl contenuto codificato in base64, se è binario
resource.mimeTypestringOpzionale
Questo esempio mostra un blocco risorsa restituito dall’interno di un handler dello strumento. L’URI file:///tmp/report.md è un’etichetta che Claude può riferire in seguito; l’SDK non legge da quel percorso.
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
      }
    }
  ]
};
Queste forme di blocco provengono dal tipo MCP CallToolResult. Vedi la specifica MCP per la definizione completa.

Restituire dati strutturati

structuredContent è un oggetto JSON opzionale sul risultato, separato dall’array content. Usalo per restituire valori grezzi che Claude può leggere come campi esatti invece di analizzarli da una stringa di testo o da un’immagine. Quando structuredContent è impostato, Claude riceve il JSON più eventuali blocchi di immagine o risorsa da content. I blocchi di testo in content non vengono inoltrati, poiché si presume che duplichino i dati strutturati. L’esempio di seguito renderizza un grafico come blocco immagine e restituisce i punti dati dietro di esso in structuredContent dallo stesso handler.
TypeScript
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]
  }
};
Il decoratore Python @tool inoltro solo content e is_error dal dict di ritorno dell’handler. Per restituire structuredContent da Python, esegui un server MCP standalone invece di un server SDK in-process.

Esempio: convertitore di unità

Questo strumento converte valori tra unità di lunghezza, temperatura e peso. Un utente può chiedere “converti 100 chilometri in miglia” o “quanto è 72°F in Celsius”, e Claude sceglie il tipo di unità e le unità corrette dalla richiesta. Dimostra due pattern:
  • Schemi enum: unit_type è vincolato a un insieme fisso di valori. In TypeScript, usa z.enum(). In Python, lo schema dict non supporta enum, quindi è richiesto il dict JSON Schema completo.
  • Gestione dell’input non supportato: quando una coppia di conversione non viene trovata, l’handler restituisce isError: true in modo che Claude possa dire all’utente cosa è andato storto invece di trattare un fallimento come un risultato normale.
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],
)
Una volta definito il server, passalo a query nello stesso modo dell’esempio meteo. Questo esempio invia tre prompt diversi in un ciclo per mostrare lo stesso strumento che gestisce diversi tipi di unità. Per ogni risposta, ispeziona gli oggetti AssistantMessage (che contengono le chiamate dello strumento che Claude ha fatto durante quel turno) e stampa ogni ToolUseBlock prima di stampare il testo finale di ResultMessage. Questo ti permette di vedere quando Claude sta usando lo strumento rispetto a rispondere dalla sua stessa conoscenza.
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:
        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")


asyncio.run(main())

Passaggi successivi

Gli strumenti personalizzati avvolgono funzioni asincrone in un’interfaccia standard. Puoi mescolare i pattern su questa pagina nello stesso server: un singolo server può contenere uno strumento di database, uno strumento di gateway API e un renderer di immagini uno accanto all’altro. Da qui:
  • Se il tuo server cresce fino a dozzine di strumenti, vedi tool search per differire il caricamento fino a quando Claude ne ha bisogno.
  • Per connettersi a server MCP esterni (filesystem, GitHub, Slack) invece di costruire il tuo, vedi Connetti server MCP.
  • Per controllare quali strumenti vengono eseguiti automaticamente rispetto a quelli che richiedono approvazione, vedi Configurare le autorizzazioni.

Documentazione correlata