query e controlar quais ferramentas Claude pode acessar. Também cobre tratamento de erros, anotações de ferramentas e retorno de conteúdo não-texto como imagens.
Referência rápida
| Se você quer… | Faça isto |
|---|---|
| Definir uma ferramenta | Use @tool (Python) ou tool() (TypeScript) com um nome, descrição, esquema e manipulador. Veja Criar uma ferramenta personalizada. |
| Registrar uma ferramenta com Claude | Envolva em create_sdk_mcp_server / createSdkMcpServer e passe para mcpServers em query(). Veja Chamar uma ferramenta personalizada. |
| Pré-aprovar uma ferramenta | Adicione às suas ferramentas permitidas. Veja Configurar ferramentas permitidas. |
| Remover uma ferramenta integrada do contexto de Claude | Passe um array tools listando apenas os integrados que você quer. Veja Configurar ferramentas permitidas. |
| Deixar Claude chamar ferramentas em paralelo | Defina readOnlyHint: true em ferramentas sem efeitos colaterais. Veja Adicionar anotações de ferramentas. |
| Tratar erros sem parar o loop | Retorne isError: true em vez de lançar uma exceção. Veja Tratar erros. |
| Retornar imagens ou arquivos | Use blocos image ou resource no array de conteúdo. Veja Retornar imagens e recursos. |
| Retornar um resultado JSON legível por máquina | Defina structuredContent no resultado. Veja Retornar dados estruturados. |
| Escalar para muitas ferramentas | Use tool search para carregar ferramentas sob demanda. |
Criar uma ferramenta personalizada
Uma ferramenta é definida por quatro partes, passadas como argumentos para o auxiliartool() em TypeScript ou o decorador @tool em Python:
- Nome: um identificador único que Claude usa para chamar a ferramenta.
- Descrição: o que a ferramenta faz. Claude lê isto para decidir quando chamá-la.
- Esquema de entrada: os argumentos que Claude deve fornecer. Em TypeScript isto é sempre um esquema Zod, e os
argsdo manipulador são tipados automaticamente a partir dele. Em Python isto é um dict mapeando nomes para tipos, como{"latitude": float}, que o SDK converte para JSON Schema para você. O decorador Python também aceita um dict completo de JSON Schema diretamente quando você precisa de enums, intervalos, campos opcionais ou objetos aninhados. - Manipulador: a função assíncrona que executa quando Claude chama a ferramenta. Ela recebe os argumentos validados e deve retornar um objeto com:
content(obrigatório): um array de blocos de resultado, cada um com umtypede"text","image"ou"resource". Veja Retornar imagens e recursos para blocos não-texto.structuredContent(opcional): um objeto JSON contendo o resultado como dados legíveis por máquina, retornado junto comcontent. Veja Retornar dados estruturados.isError(opcional): defina comotruepara sinalizar uma falha de ferramenta para que Claude possa reagir a ela. Veja Tratar erros.
createSdkMcpServer (TypeScript) ou create_sdk_mcp_server (Python). O servidor executa em processo dentro de sua aplicação, não como um processo separado.
Exemplo de ferramenta de clima
Este exemplo define uma ferramentaget_temperature e a envolve em um servidor MCP. Ele apenas configura a ferramenta; para passá-la para query e executá-la, veja Chamar uma ferramenta personalizada abaixo.
tool() ou a referência Python @tool para detalhes completos de parâmetros, incluindo formatos de entrada JSON Schema e estrutura de valor de retorno.
Chamar uma ferramenta personalizada
Passe o servidor MCP que você criou paraquery via a opção mcpServers. A chave em mcpServers torna-se o segmento {server_name} no nome totalmente qualificado de cada ferramenta: mcp__{server_name}__{tool_name}. Liste esse nome em allowedTools para que a ferramenta execute sem um prompt de permissão.
Estes trechos reutilizam o weatherServer do exemplo acima para perguntar a Claude qual é o clima em um local específico.
Adicionar mais ferramentas
Um servidor contém quantas ferramentas você listar em seu arraytools. Com mais de uma ferramenta em um servidor, você pode listar cada uma em allowedTools individualmente ou usar o curinga mcp__weather__* para cobrir cada ferramenta que o servidor expõe.
O exemplo abaixo adiciona uma segunda ferramenta, get_precipitation_chance, ao weatherServer do exemplo de ferramenta de clima e o reconstrói com ambas as ferramentas no array.
Adicionar anotações de ferramentas
Anotações de ferramentas são metadados opcionais descrevendo como uma ferramenta se comporta. Passe-as como o quinto argumento para o auxiliartool() em TypeScript ou via o argumento de palavra-chave annotations para o decorador @tool em Python. Todos os campos de dica são Booleanos.
| Campo | Padrão | Significado |
|---|---|---|
readOnlyHint | false | A ferramenta não modifica seu ambiente. Controla se a ferramenta pode ser chamada em paralelo com outras ferramentas somente leitura. |
destructiveHint | true | A ferramenta pode executar atualizações destrutivas. Apenas informativo. |
idempotentHint | false | Chamadas repetidas com os mesmos argumentos não têm efeito adicional. Apenas informativo. |
openWorldHint | true | A ferramenta alcança sistemas fora de seu processo. Apenas informativo. |
readOnlyHint: true ainda pode escrever em disco se é isso que o manipulador faz. Mantenha a anotação precisa em relação ao manipulador.
Este exemplo adiciona readOnlyHint à ferramenta get_temperature do exemplo de ferramenta de clima.
ToolAnnotations na referência TypeScript ou Python.
Controlar acesso a ferramentas
O exemplo de ferramenta de clima registrou um servidor e listou ferramentas emallowedTools. Esta seção cobre como nomes de ferramentas são construídos e como escopar acesso quando você tem múltiplas ferramentas ou quer restringir integrados.
Formato de nome de ferramenta
Quando ferramentas MCP são expostas a Claude, seus nomes seguem um formato específico:- Padrão:
mcp__{server_name}__{tool_name} - Exemplo: Uma ferramenta nomeada
get_temperatureno servidorweathertorna-semcp__weather__get_temperature
Configurar ferramentas permitidas
A opçãotools e as listas de permitidas/não permitidas afetam duas camadas: disponibilidade, que controla se uma ferramenta aparece no contexto de Claude, e permissão, que controla se uma chamada é aprovada uma vez que Claude tenta. tools e entradas de disallowedTools com nome simples alteram a disponibilidade. allowedTools e regras de disallowedTools com escopo alteram apenas a permissão.
| Opção | Camada | Efeito |
|---|---|---|
tools: ["Read", "Grep"] | Disponibilidade | Apenas os integrados listados estão no contexto de Claude. Integrados não listados são removidos. Ferramentas MCP não são afetadas. |
tools: [] | Disponibilidade | Todos os integrados são removidos. Claude pode usar apenas suas ferramentas MCP. |
| ferramentas permitidas | Permissão | Ferramentas listadas executam sem um prompt de permissão. Ferramentas não listadas permanecem disponíveis; chamadas passam pelo fluxo de permissão. |
| ferramentas não permitidas | Ambas | Um nome de ferramenta simples como "Bash" remove a ferramenta do contexto de Claude, o mesmo que omiti-la de tools. Uma regra com escopo como "Bash(rm *)" deixa a ferramenta no contexto e nega apenas chamadas correspondentes. |
tools ou liste seu nome simples em disallowedTools (Python: disallowed_tools); ambos mantêm a ferramenta fora do contexto para que Claude nunca tente. Uma regra disallowedTools com escopo bloqueia chamadas correspondentes mas deixa a ferramenta visível, então Claude pode desperdiçar um turno tentando. Veja Configurar permissões para a ordem de avaliação completa.
Tratar erros
Como seu manipulador relata erros determina se o loop do agente continua ou para:| O que acontece | Resultado |
|---|---|
| Manipulador lança uma exceção não capturada | Loop do agente para. Claude nunca vê o erro, e a chamada query falha. |
Manipulador captura o erro e retorna isError: true (TS) / "is_error": True (Python) | Loop do agente continua. Claude vê o erro como dados e pode tentar novamente, tentar uma ferramenta diferente ou explicar a falha. |
try/except (Python) ou try/catch (TypeScript) circundante e também retornado como um resultado de erro. Em ambos os casos o manipulador retorna normalmente e o loop do agente continua.
Retornar imagens e recursos
O arraycontent em um resultado de ferramenta aceita blocos text, image e resource. Você pode misturá-los na mesma resposta.
Imagens
Um bloco de imagem carrega os bytes da imagem inline, codificados como base64. Não há campo de URL. Para retornar uma imagem que vive em uma URL, busque-a no manipulador, leia os bytes da resposta e codifique-os em base64 antes de retornar. O resultado é processado como entrada visual.| Campo | Tipo | Notas |
|---|---|---|
type | "image" | |
data | string | Bytes codificados em base64. Apenas base64 bruto, sem prefixo data:image/...;base64, |
mimeType | string | Obrigatório. Por exemplo image/png, image/jpeg, image/webp, image/gif |
Recursos
Um bloco de recurso incorpora um pedaço de conteúdo identificado por uma URI. A URI é um rótulo para Claude referenciar; o conteúdo real fica no campotext ou blob do bloco. Use isto quando sua ferramenta produz algo que faz sentido endereçar por nome depois, como um arquivo gerado ou um registro de um sistema externo.
| Campo | Tipo | Notas |
|---|---|---|
type | "resource" | |
resource.uri | string | Identificador para o conteúdo. Qualquer esquema de URI |
resource.text | string | O conteúdo, se for texto. Forneça isto ou blob, não ambos |
resource.blob | string | O conteúdo codificado em base64, se for binário |
resource.mimeType | string | Opcional |
file:///tmp/report.md é um rótulo que Claude pode referenciar depois; o SDK não lê desse caminho.
CallToolResult. Veja a especificação MCP para a definição completa.
Retornar dados estruturados
structuredContent é um objeto JSON opcional no resultado, separado do array content. Use-o para retornar valores brutos que Claude pode ler como campos exatos em vez de analisá-los de uma string de texto ou imagem.
Quando structuredContent é definido, Claude recebe o JSON mais quaisquer blocos de imagem ou recurso de content. Blocos de texto em content não são encaminhados, já que são assumidos duplicar os dados estruturados. O exemplo abaixo renderiza um gráfico como um bloco de imagem e retorna os pontos de dados por trás dele em structuredContent do mesmo manipulador.
TypeScript
O decorador Python
@tool encaminha apenas content e is_error do dict de retorno do manipulador. Para retornar structuredContent de Python, execute um servidor MCP autônomo em vez de um servidor SDK em processo.Exemplo: conversor de unidades
Esta ferramenta converte valores entre unidades de comprimento, temperatura e peso. Um usuário pode perguntar “converter 100 quilômetros para milhas” ou “qual é 72°F em Celsius,” e Claude escolhe o tipo de unidade certo e unidades da solicitação. Demonstra dois padrões:- Esquemas de enum:
unit_typeé restrito a um conjunto fixo de valores. Em TypeScript, usez.enum(). Em Python, o esquema dict não suporta enums, então o dict completo de JSON Schema é necessário. - Tratamento de entrada não suportada: quando um par de conversão não é encontrado, o manipulador retorna
isError: truepara que Claude possa dizer ao usuário o que deu errado em vez de tratar uma falha como um resultado normal.
query da mesma forma que o exemplo de clima. Este exemplo envia três prompts diferentes em um loop para mostrar a mesma ferramenta tratando diferentes tipos de unidades. Para cada resposta, ele inspeciona objetos AssistantMessage (que contêm as chamadas de ferramenta que Claude fez durante esse turno) e imprime cada ToolUseBlock antes de imprimir o texto final de ResultMessage. Isto permite que você veja quando Claude está usando a ferramenta versus respondendo de seu próprio conhecimento.
Próximos passos
Ferramentas personalizadas envolvem funções assíncronas em uma interface padrão. Você pode misturar os padrões nesta página no mesmo servidor: um único servidor pode conter uma ferramenta de banco de dados, uma ferramenta de gateway de API e um renderizador de imagem lado a lado. A partir daqui:- Se seu servidor crescer para dezenas de ferramentas, veja tool search para adiar o carregamento delas até Claude precisar delas.
- Para conectar a servidores MCP externos (sistema de arquivos, GitHub, Slack) em vez de construir os seus próprios, veja Conectar servidores MCP.
- Para controlar quais ferramentas executam automaticamente versus exigindo aprovação, veja Configurar permissões.