Skip to main content
skill CX Codex

vtex-io-service-configuration-apps — Claude Code skill

Guides the agent through building VTEX IO configuration apps using the configuration builder. Helps inject decoupled workspace settings into service runtimes.

Install into Claude Code · Skills CLI (Vercel) All methods and platforms ↓
npx skills add vtex/skills --skill vtex-io-service-configuration-apps -a claude-code
Open on GitHub

What vtex-io-service-configuration-apps does

This skill defines architectural patterns for externalizing VTEX IO service settings into separate configuration apps. Instead of bundling values into local settings, the service app specifies the data contract in configuration/schema.json. The configuration app then supplies concrete definitions through the configuration builder.

Separation of concerns is mandatory here. Configuration apps must not declare node or graphql builders. To consume settings, service routes or events in node/service.json need settingsType: "workspace", or the @settings directive in GraphQL. The handler then retrieves payload data straight from ctx.vtex.settings.

Making ad hoc HTTP requests to fetch these values defeats the architecture. If a service encounters workspace permission issues while resolving settings, inspect whether the read-workspace-apps policy is missing. Extra properties should be blocked in schema contracts with additionalProperties: false.

What it helps with

  • decouple configuration lifecycles from backend service deployments
  • register service entrypoints with settingsType: workspace or @settings
  • declare strict JSON Schema contracts in configuration/schema.json
  • extract injected settings from ctx.vtex.settings without extra HTTP calls

Example prompts for the agent

  • Structure a dedicated configuration app for our shipping-service using the configuration builder.
  • Update node/service.json to expose routes for workspace settings injection.
  • Create a closed configuration/schema.json schema to validate injected payment configuration.

How to install vtex-io-service-configuration-apps

1Skills CLI (Vercel)

npx skills add vtex/skills --skill vtex-io-service-configuration-apps -a claude-code

2Manually: put the files in place

~/.claude/skills/vtex-io-service-configuration-apps/SKILL.md

Copy the whole skill folder; for one project use .claude/skills/vtex-io-service-configuration-apps/

Step by step, with commands for each platform: How to install skills in Claude Code: five ways

Questions about vtex-io-service-configuration-apps

How to install vtex-io-service-configuration-apps in Claude Code?

Run npx skills add vtex/skills --skill vtex-io-service-configuration-apps -a claude-code in your terminal.

What does the vtex-io-service-configuration-apps skill do?

It provides implementation rules for building VTEX IO configuration apps and feeding structured runtime settings into service apps.

When should you pick a configuration app over settingsSchema?

Choose a configuration app when settings must be shared across multiple services or managed independently from the runtime service lifecycle.

Similar skills

All skills for Backend and APIs →

From the same set38

vtex-io-service-paths-and-cdn Picks the right path prefix in service.json and matches Cache-Control to the data, so edge caching does not serve one shopper's payload to another. CX Codex +1 1,100installs vtex-io-messages-and-i18n Keeps user-facing copy in the VTEX IO messages infrastructure instead of hardcoded strings in JSX and resolvers. CX Codex +1 1,100installs vtex-io-security-boundaries Guides coding assistants when auditing route exposure and data boundaries in VTEX IO apps. Prevents tenant leaks and enforces payload validation. CX Codex +1 1,100installs vtex-io-events-and-workers Guides the agent in writing VTEX IO event handlers and workers that survive duplicate delivery. Useful when slow work should leave your HTTP routes. CX Codex +1 1,100installs vtex-io-app-contract Checks the VTEX IO app contract in manifest.json, including builders and dependency links. Use it when creating, splitting, or publishing apps. CX Codex +1 1,100installs vtex-io-service-runtime Guides the runtime layout of a VTEX IO backend app: the Service entrypoint, typed context, and service.json execution settings. CX Codex +1 1,100installs vtex-io-data-access-patterns Guides AI coding agents on picking the right storage layer across VTEX IO apps. It helps design read pipelines, caching strategies, and data boundaries. CX Codex +1 1,100installs vtex-io-auth-tokens-and-context Decides which VTEX IO token should back a backend request: the app itself, a shopper, or an Admin user. CX Codex +1 1,100installs

Project sponsors

Companies that keep this analytics open
Gold sponsor

Impressions, clicks and code copies — open statistics. We keep the numbers public for the same reason NeBlask itself is public. Become a sponsor