AIKraft/Skills/VTEX IO: настройки приложения

VTEX IO: настройки приложения

Apply when defining, validating, or consuming VTEX IO app settings. Covers settingsSchema, app-level configuration boundaries, and how backend or frontend code should depend on settings safely. Use for merchant-configurable behavior, settings forms, or reviewing whether settings belong in app configuration rather than hardcoded logic or custom data entities.

vtex official Дизайн

Что делает навык

Навык определяет правила создания, валидации и использования настроек приложения VTEX IO через settingsSchema, разделяя границы конфигурации приложения и пользовательских данных. Он обеспечивает безопасное хранение секретов на бэкенде и предотвращает использование настроек для хранения операционных данных.

Когда применять

  • Определение структуры настроек приложения через settingsSchema для мерчантов.
  • Валидация и нормализация настроек при чтении в коде приложения.
  • Разграничение публичных настроек для фронтенда и секретов для бэкенда.
  • Проверка того, что конфигурация относится к настройкам приложения, а не к Store Framework блокам.

Как работает

  1. Определите settingsSchema с явными свойствами (properties), типами, required и default, избегая generic object.
  2. Используйте access: 'public' только для нечувствительных значений, безопасных для передачи во фронтенд через publicSettingsForApp.
  3. Храните секреты (API keys, токены) как type: string с format: 'password', но не полагайтесь на маскировку как на единую меру безопасности.
  4. Читайте настройки через ctx.clients.apps.getAppSettings() с правильным appId и токеном приложения.
  5. Валидируйте или применяйте значения по умолчанию при потреблении настроек, чтобы код был устойчив к отсутствующим полям.
  6. Никогда не возвращайте сырые настройки или секреты в HTTP/GraphQL ответах или логах.

Примеры запросов агенту

Создай settingsSchema для приложения, где apiKey должен быть секретом, а enableModeration — публичной настройкой.
Проверь, правильно ли код читает настройки приложения через getAppSettings и применяет ли значения по умолчанию.
Объясни, почему нельзя использовать settingsSchema для хранения списка всех отзывов пользователей.

Что понадобится

  • Среда VTEX IO
  • Доступ к manifest.json и контексту приложения (ctx.vtex.appId)
  • Знание JSON Schema для определения структуры настроек

Описание составлено по SKILL.md навыка, сверено 06.10.2026.

Как подключить

1Скачать навык
# возьмите папку навыка «vtex-io-app-settings» из репозитория: # https://github.com/vtex/skills
2Положить папку с SKILL.md к навыкам ассистента
# положите папку навыка туда, где ассистент ищет skills: cp -r vtex-io-app-settings/ ~/.claude/skills/vtex-io-app-settings/

Навык — папка с файлом SKILL.md (описание + инструкции) и опциональными скриптами. Ассистент (Claude, Claude Code и совместимые) подхватывает его по описанию и следует шагам.