SpyBara
Go Premium

agent-sdk/plugins.md 2026-09-13 21:00 UTC to 2026-09-14 22:58 UTC

This page contains 1 addition and 1 deletion.

2026
Wed 9 22:58 Mon 14 22:58 Fri 25 23:58

Plugins no SDK

Carregue plugins personalizados para estender Claude Code com skills, agentes, hooks e servidores MCP através do Agent SDK

Plugins permitem que você estenda Claude Code com funcionalidade personalizada que pode ser compartilhada entre projetos. Através do Agent SDK, você pode carregar programaticamente plugins de diretórios locais para adicionar capacidades às suas sessões de agente. Um plugin pode incluir:

  • Skills: capacidades que Claude invoca autonomamente quando relevante. Você também pode invocar uma skill de plugin diretamente com /plugin-name:skill-name.
  • Agents: subagentes especializados para tarefas específicas
  • Hooks: manipuladores de eventos que respondem ao uso de ferramentas e outros eventos
  • MCP servers: integrações de ferramentas externas via Model Context Protocol

Para informações completas sobre a estrutura de plugins e como criar plugins, consulte Plugins.

Carregando plugins

Carregue plugins fornecendo seus caminhos do sistema de arquivos local na configuração de opções. O campo type deve ser "local", o único valor que o SDK aceita. O SDK suporta carregamento de múltiplos plugins de diferentes locais.

Para usar um plugin distribuído através de um marketplace ou repositório remoto, baixe-o primeiro e forneça o caminho do diretório local. Para o layout de diretório que um plugin precisa, consulte a referência de estrutura de plugin abaixo.

import { query } from "@anthropic-ai/claude-agent-sdk";

for await (const message of query({
prompt: "Hello",
options: {
plugins: [
{ type: "local", path: "./my-plugin" },
{ type: "local", path: "/absolute/path/to/another-plugin" }
]
}
})) {
// Plugin commands, agents, and other features are now available
}

Especificações de caminho

Os caminhos de plugin podem ser:

  • Caminhos relativos: resolvidos relativamente à opção cwd (por exemplo, "./plugins/my-plugin")
  • Caminhos absolutos: caminhos completos do sistema de arquivos (por exemplo, "/home/user/plugins/my-plugin")

Verificando a instalação do plugin

Quando os plugins carregam com sucesso, eles aparecem na mensagem de inicialização do sistema. Você pode verificar que seus plugins estão disponíveis:

import { query } from "@anthropic-ai/claude-agent-sdk";

for await (const message of query({
prompt: "Hello",
options: {
plugins: [{ type: "local", path: "./my-plugin" }]
}
})) {
if (message.type === "system" && message.subtype === "init") {
// Check loaded plugins
console.log("Plugins:", message.plugins);
// Example: [{ name: "my-plugin", path: "/absolute/path/to/my-plugin" }]

// Plugin skills appear with the plugin name as a prefix
console.log("Skills:", message.skills);
// Example: ["my-plugin:greet"]

// Plugin commands use the same prefix, and skills appear here too
console.log("Commands:", message.slash_commands);
// Example: ["compact", "context", "my-plugin:custom-command", "my-plugin:greet"]
}
}

Usando skills de plugins

Skills de plugins são automaticamente nomeados com o nome do plugin para evitar conflitos. Para invocar um diretamente, envie /plugin-name:skill-name como o prompt.

import { query } from "@anthropic-ai/claude-agent-sdk";

// Load a plugin with a custom /greet skill
for await (const message of query({
prompt: "/my-plugin:greet", // Use plugin skill with namespace
options: {
plugins: [{ type: "local", path: "./my-plugin" }]
}
})) {
// Claude executes the custom greeting skill from the plugin
if (message.type === "assistant") {
console.log(message.message.content);
}
}

Exemplo completo

Aqui está um exemplo completo demonstrando carregamento e uso de plugins:

import { query } from "@anthropic-ai/claude-agent-sdk";
import { fileURLToPath } from "node:url";

async function runWithPlugin() {
const pluginPath = fileURLToPath(new URL("./plugins/my-plugin", import.meta.url));

console.log("Loading plugin from:", pluginPath);

for await (const message of query({
prompt: "What custom commands do you have available?",
options: {
plugins: [{ type: "local", path: pluginPath }],
maxTurns: 3
}
})) {
if (message.type === "system" && message.subtype === "init") {
console.log("Loaded plugins:", message.plugins);
console.log("Available skills:", message.skills);
console.log("Available commands:", message.slash_commands);
}

if (message.type === "assistant") {
console.log("Assistant:", message.message.content);
}
}
}

runWithPlugin().catch(console.error);

Referência de estrutura de plugin

Um diretório de plugin normalmente contém um arquivo de manifesto .claude-plugin/plugin.json. O manifesto é opcional. Quando omitido, Claude Code descobre automaticamente componentes a partir do layout do diretório. O diretório pode incluir:

my-plugin/
├── .claude-plugin/
│   └── plugin.json          # Plugin manifest (optional, components auto-discovered without it)
├── skills/                   # Agent Skills (invoked autonomously or via /plugin-name:skill-name)
│   └── my-skill/
│       └── SKILL.md
├── commands/                 # Skills as flat .md files
│   └── custom-cmd.md
├── agents/                   # Custom agents
│   └── specialist.md
├── hooks/                    # Event handlers
│   └── hooks.json
└── .mcp.json                # MCP server definitions

Múltiplas fontes de plugin

Combine plugins de diferentes locais:

import * as os from "node:os";
import * as path from "node:path";

plugins: [
  { type: "local", path: "./local-plugin" },
  {
    type: "local",
    path: path.join(os.homedir(), ".claude", "custom-plugins", "shared-plugin")
  }
];

Troubleshooting

Plugin não carregando

Se seu plugin não aparecer na mensagem de inicialização:

  1. Verifique o caminho: certifique-se de que o caminho aponta para o diretório raiz do plugin, o diretório pai de skills/, agents/, hooks/, commands/, ou .claude-plugin/
  2. Valide plugin.json: se seu plugin inclui um manifesto, certifique-se de que ele tem sintaxe JSON válida
  3. Verifique permissões de arquivo: certifique-se de que o diretório do plugin é legível
  4. Confirme que o diretório existe: o SDK pula um caminho inexistente, e o plugin não aparece na lista plugins da mensagem de inicialização

Skills não aparecendo

Se skills de plugins não funcionarem:

  1. Use o namespace: invoque skills de plugins como /plugin-name:skill-name
  2. Verifique mensagem de inicialização: verifique se a skill aparece na lista skills com o namespace correto
  3. Valide arquivos de skill: certifique-se de que cada skill tem um arquivo SKILL.md em seu próprio subdiretório sob skills/, por exemplo skills/my-skill/SKILL.md

Veja também