Saltar al contenido principal
El Agent SDK se basa en la misma base que Claude Code, lo que significa que sus agentes SDK tienen acceso a las mismas características basadas en el sistema de archivos: instrucciones de proyecto (CLAUDE.md y reglas), skills, hooks y más. Cuando omite settingSources, query() lee la misma configuración del sistema de archivos que la CLI de Claude Code: configuración de usuario, proyecto y local, archivos CLAUDE.md y skills, agentes y comandos en .claude/. Para ejecutar sin estos, pase settingSources: [], lo que limita el agente a lo que configure programáticamente. La configuración de políticas administradas y la configuración global ~/.claude.json se leen independientemente de esta opción. Consulte Qué settingSources no controla. Para una descripción conceptual de lo que hace cada característica y cuándo usarla, consulte Extender Claude Code.

Controlar la configuración del sistema de archivos con settingSources

La opción de fuentes de configuración (setting_sources en Python, settingSources en TypeScript) controla qué configuración basada en el sistema de archivos carga el SDK. Pase una lista explícita para optar por fuentes específicas, o pase una matriz vacía para deshabilitar la configuración de usuario, proyecto y local. Este ejemplo carga tanto la configuración a nivel de usuario como a nivel de proyecto estableciendo settingSources en ["user", "project"]:
Cada fuente carga la configuración desde una ubicación específica, donde <cwd> es el directorio de trabajo que pasa a través de la opción cwd, o el directorio actual del proceso si no está establecido. Para la definición de tipo completa, consulte SettingSource (TypeScript) o SettingSource (Python). Omitir settingSources es equivalente a ["user", "project", "local"]. La opción cwd determina dónde busca el SDK las entradas a nivel de proyecto. CLAUDE.md y rules se cargan desde <cwd> y desde cada directorio padre. Skills se cargan desde <cwd> y desde cada directorio padre hasta la raíz del repositorio. settings.json del proyecto y hooks se cargan solo desde <cwd>/.claude/ sin fallback de directorio padre.

Qué settingSources no controla

settingSources cubre la configuración de usuario, proyecto y local. Algunas entradas se leen independientemente de su valor:
No confíe en las opciones predeterminadas de query() para el aislamiento multiinquilino. Debido a que las entradas anteriores se leen independientemente de settingSources, un proceso SDK puede recopilar configuración a nivel de host y memoria por directorio. Para implementaciones multiinquilino, ejecute cada inquilino en su propio sistema de archivos y establezca settingSources: [] más CLAUDE_CODE_DISABLE_AUTO_MEMORY=1 en env. La configuración administrada por servidor se obtiene cuando el proceso se autentica con una credencial de la organización; el aislamiento del sistema de archivos no las elimina. Consulte Implementación segura.

Instrucciones de proyecto (CLAUDE.md y reglas)

Los archivos CLAUDE.md y los archivos .claude/rules/*.md proporcionan a su agente contexto persistente sobre su proyecto: convenciones de codificación, comandos de compilación, decisiones de arquitectura e instrucciones. Cuando settingSources incluye "project" (como en el ejemplo anterior), el SDK carga estos archivos en el contexto al inicio de la sesión. El agente luego sigue sus convenciones de proyecto sin que tenga que repetirlas en cada mensaje.

Ubicaciones de carga de CLAUDE.md

Todos los niveles son aditivos: si existen archivos CLAUDE.md tanto de proyecto como de usuario, el agente ve ambos. No hay una regla de precedencia dura entre niveles; si las instrucciones entran en conflicto, el resultado depende de cómo Claude las interprete. Escriba reglas que no entren en conflicto, o indique la precedencia explícitamente en el archivo más específico (“Estas instrucciones de proyecto anulan cualquier valor predeterminado conflictivo a nivel de usuario”).
También puede inyectar contexto directamente a través de systemPrompt sin usar archivos CLAUDE.md. Consulte Modificar mensajes del sistema. Use CLAUDE.md cuando desee que el mismo contexto se comparta entre sesiones interactivas de Claude Code y sus agentes SDK.
Para saber cómo estructurar y organizar el contenido de CLAUDE.md, consulte Administrar la memoria de Claude.

Skills

Los skills son archivos markdown que proporcionan a su agente conocimiento especializado y flujos de trabajo invocables. A diferencia de CLAUDE.md (que se carga cada sesión), los skills se cargan bajo demanda. El agente recibe descripciones de skills al inicio y carga el contenido completo cuando es relevante. Los skills se descubren desde el sistema de archivos a través de settingSources. Cuando la opción skills en query() se omite, los skills de usuario y proyecto descubiertos se habilitan y la herramienta Skill está disponible, coincidiendo con el comportamiento de CLI. Para controlar qué skills están habilitados, pase skills como "all", una lista de nombres de skills, o [] para deshabilitar todos. Cuando skills está configurado, el SDK agrega automáticamente la herramienta Skill a allowedTools. Si también pasa una lista explícita de tools, incluya "Skill" en esa lista para que Claude pueda invocar skills.
Los skills deben crearse como artefactos del sistema de archivos (.claude/skills/<name>/SKILL.md). El SDK no tiene una API programática para registrar skills. Consulte Agent Skills en el SDK para obtener detalles completos.
Para obtener más información sobre cómo crear y usar skills, consulte Agent Skills en el SDK.

Hooks

El SDK admite dos formas de definir hooks, y se ejecutan lado a lado:
  • Hooks del sistema de archivos: comandos de shell definidos en settings.json, cargados cuando settingSources incluye la fuente relevante. Estos son los mismos hooks que configuraría para sesiones interactivas de Claude Code.
  • Hooks programáticos: funciones de devolución de llamada pasadas directamente a query(). Se ejecutan en el proceso de su aplicación y pueden devolver decisiones estructuradas. Consulte Controlar la ejecución con hooks.
Ambos tipos se ejecutan durante el mismo ciclo de vida del hook. Si ya tiene hooks en el .claude/settings.json de su proyecto y establece settingSources: ["project"], esos hooks se ejecutan automáticamente en el SDK sin configuración adicional. Las devoluciones de llamada de hooks reciben la entrada de la herramienta y devuelven un diccionario de decisión. Devolver {} significa permitir que la herramienta continúe. Para bloquear la ejecución, devuelva un objeto hookSpecificOutput con permissionDecision: "deny" y un permissionDecisionReason. La razón se envía a Claude como el resultado de la herramienta. Los campos decision y reason de nivel superior están deprecados para PreToolUse. Consulte la guía de hooks para la firma de devolución de llamada completa y los tipos de retorno.

Cuándo usar qué tipo de hook

El SDK de TypeScript admite eventos de hook adicionales más allá de Python, incluidos SessionStart, SessionEnd, TeammateIdle y TaskCompleted. Consulte la guía de hooks para la tabla de compatibilidad de eventos completa.
Para obtener detalles completos sobre hooks programáticos, consulte Controlar la ejecución con hooks. Para la sintaxis de hooks del sistema de archivos, consulte Hooks.

Elegir la característica correcta

El Agent SDK le proporciona acceso a varias formas de extender el comportamiento de su agente. Si no está seguro de cuál usar, esta tabla asigna objetivos comunes al enfoque correcto.
Subagentos versus equipos de agentes: Los subagentos son efímeros y aislados: conversación nueva, una tarea, resumen devuelto al padre. Los equipos de agentes coordinan múltiples instancias independientes de Claude Code que comparten una lista de tareas y se envían mensajes directamente entre sí. Los equipos de agentes son una característica CLI. Consulte Qué heredan los subagentos y la comparación de equipos de agentes para obtener detalles.
Cada característica que habilita se suma a la ventana de contexto de su agente. Para costos por característica y cómo se superponen estas características, consulte Extender Claude Code.
  • Extender Claude Code: Descripción conceptual de todas las características de extensión, con tablas de comparación y análisis de costos de contexto
  • Skills en el SDK: Guía completa para usar skills programáticamente
  • Subagentos: Defina e invoque subagentos para subtareas aisladas
  • Hooks: Intercepte y controle el comportamiento del agente en puntos de ejecución clave
  • Permisos: Controle el acceso a herramientas con modos, reglas y devoluciones de llamada
  • Mensajes del sistema: Inyecte contexto sin archivos CLAUDE.md