Разрешения SDK
Claude Agent SDK предоставляет мощные средства управления разрешениями, которые позволяют вам управлять тем, как Claude использует инструменты в вашем приложении. Это руководство охватывает, как реализовать системы разрешений, используя обратный вызовcanUseTool
, хуки и правила разрешений settings.json. Для полной документации API см. справочник TypeScript SDK.
Обзор
Claude Agent SDK предоставляет четыре дополняющих способа управления использованием инструментов:- Режимы разрешений - Глобальные настройки поведения разрешений, которые влияют на все инструменты
- обратный вызов canUseTool - Обработчик разрешений во время выполнения для случаев, не покрытых другими правилами
- Хуки - Детальное управление каждым выполнением инструмента с пользовательской логикой
- Правила разрешений (settings.json) - Декларативные правила разрешения/запрета с интегрированным парсингом bash-команд
- Режимы разрешений - Установка общего поведения разрешений (планирование, автоматическое принятие правок, обход проверок)
canUseTool
- Динамическое одобрение для непокрытых случаев, запрашивает разрешение у пользователя- Хуки - Программное управление всеми выполнениями инструментов
- Правила разрешений - Статические политики с интеллектуальным парсингом bash-команд
Диаграмма потока разрешений
Порядок обработки: PreToolUse Hook → Правила Ask → Правила Deny → Проверка режима разрешений → Правила Allow → обратный вызов canUseTool → PostToolUse HookРежимы разрешений
Режимы разрешений обеспечивают глобальное управление тем, как Claude использует инструменты. Вы можете установить режим разрешений при вызовеquery()
или изменить его динамически во время потоковых сессий.
Доступные режимы
SDK поддерживает четыре режима разрешений, каждый с различным поведением:Режим | Описание | Поведение инструмента |
---|---|---|
default | Стандартное поведение разрешений | Применяются обычные проверки разрешений |
plan | Режим планирования - без выполнения | Claude может использовать только инструменты только для чтения; представляет план перед выполнением (В настоящее время не поддерживается в SDK) |
acceptEdits | Автоматическое принятие правок файлов | Правки файлов и операции файловой системы автоматически одобряются |
bypassPermissions | Обход всех проверок разрешений | Все инструменты выполняются без запросов разрешений (используйте с осторожностью) |
Установка режима разрешений
Вы можете установить режим разрешений двумя способами:1. Начальная конфигурация
Установите режим при создании запроса:2. Динамические изменения режима (только потоковая передача)
Измените режим во время потоковой сессии:Поведение, специфичное для режима
Режим принятия правок (acceptEdits
)
В режиме принятия правок:
- Все правки файлов автоматически одобряются
- Операции файловой системы (mkdir, touch, rm и т.д.) автоматически одобряются
- Другие инструменты по-прежнему требуют обычных разрешений
- Ускоряет разработку, когда вы доверяете правкам Claude
- Полезно для быстрого прототипирования и итераций
- Правки файлов (инструменты Edit, MultiEdit, Write)
- Bash-команды файловой системы (mkdir, touch, rm, mv, cp)
- Создание и удаление файлов
Режим обхода разрешений (bypassPermissions
)
В режиме обхода разрешений:
- ВСЕ использования инструментов автоматически одобряются
- Не появляются запросы разрешений
- Хуки по-прежнему выполняются (могут по-прежнему блокировать операции)
- Используйте с крайней осторожностью - Claude имеет полный доступ к системе
- Рекомендуется только для контролируемых сред
Приоритет режима в потоке разрешений
Режимы разрешений оцениваются в определенной точке потока разрешений:- Хуки выполняются первыми - Могут переопределить любой режим
- Правила запрета проверяются - Блокируют инструменты независимо от режима
- Режим
bypassPermissions
- Если активен, разрешает все оставшиеся инструменты - Правила разрешения проверяются
- Другие режимы влияют на поведение конкретных инструментов
- обратный вызов
canUseTool
- Обрабатывает оставшиеся случаи
- Хуки всегда могут заблокировать использование инструмента, даже в режиме
bypassPermissions
- Явные правила запрета переопределяют все режимы разрешений
- Режим
bypassPermissions
переопределяет правила разрешения иcanUseTool
Лучшие практики
- Используйте режим по умолчанию для контролируемого выполнения с обычными проверками разрешений
- Используйте режим acceptEdits при работе с изолированными файлами или каталогами
- Избегайте bypassPermissions в продакшене или на системах с чувствительными данными
- Комбинируйте режимы с хуками для детального управления
- Переключайте режимы динамически в зависимости от прогресса задачи и уверенности
canUseTool
Обратный вызовcanUseTool
передается как опция при вызове функции query
. Он получает имя инструмента и входные параметры и должен вернуть решение - либо разрешить, либо запретить.
canUseTool срабатывает всякий раз, когда Claude Code показал бы запрос разрешения пользователю, например, хуки и правила разрешений не покрывают это, и он не находится в режиме автоматического принятия.
Вот полный пример, показывающий, как реализовать интерактивное одобрение инструментов:
Использование хуков для управления инструментами
Хуки обеспечивают программное управление выполнением инструментов на различных этапах. Хуки вызываются для каждого использования инструмента, давая вам полный контроль над конвейером разрешений.Реализация хуков
Ключевые отличия от canUseTool
- Область действия: Хуки вызываются для всех использований инструментов;
canUseTool
обрабатывает случаи, не покрытые правилами разрешений - Управление: Хуки требуют самостоятельного парсинга и валидации входных данных
- События: Хуки поддерживают множественные события (PreToolUse, PostToolUse и т.д.) для разных этапов
Использование правил разрешений (settings.json)
Правила разрешений вsettings.json
обеспечивают декларативное управление со встроенным парсингом bash-команд. Эти правила оцениваются до вызова canUseTool
. Для более подробной информации о конфигурации настроек см. документацию настроек Claude Code.
Структура конфигурации
Синтаксис правил
Правила разрешений следуют шаблону:ToolName(pattern)
- Правила Bash: Используют сопоставление префиксов (не регулярные выражения). Пример:
Bash(npm:*)
соответствует любой команде, начинающейся с “npm” - Правила файлов: Поддерживают glob-шаблоны. Пример:
Read(./src/**/*.ts)
соответствует файлам TypeScript в src - Правила только для инструментов: Опускают скобки для управления целыми инструментами. Пример:
WebFetch
блокирует все веб-запросы
Использование с SDK
Хотя правила еще нельзя установить программно в SDK, они будут считываться из файла settings.json в пути, где загружается SDK.Порядок оценки разрешений
- Правила запрета проверяются первыми - если совпадают, использование инструмента блокируется
- Правила разрешения проверяются далее - если совпадают, использование инструмента разрешается
- Правила запроса проверяются - если совпадают, пользователю выводится запрос
- обратный вызов canUseTool вызывается для любых оставшихся случаев
Парсинг bash-команд
SDK включает интегрированный bash-парсер, который понимает структуру команд:- Обрабатывает каналы, перенаправления и подстановку команд
- Распознает опасные шаблоны, такие как
rm -rf
илиcurl | sh
- Поддерживает подстановочные знаки и сопоставление префиксов
Bash(git:*)
- Соответствует любой git-командеBash(npm run test)
- Соответствует точной командеBash(npm run test:*)
- Соответствует Bash-командам, начинающимся сnpm run test
, таким какnpm run test anyFile.test.ts
Лучшие практики
- Начинайте с режима по умолчанию для стандартных проверок разрешений
- Используйте правила разрешений для статических политик, особенно bash-команд (см. настройки разрешений)
- Используйте хуки для логирования, аудита или трансформации всех использований инструментов (см. типы хуков)
- Используйте canUseTool для динамических решений по непокрытым случаям (см. тип CanUseTool)
- Многоуровневая защита путем комбинирования режимов, правил, хуков и обратных вызовов для критических приложений