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.
npx skills add vtex/skills --skill vtex-io-service-configuration-apps -a claude-codeWhat 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-code2Manually: put the files in place
~/.claude/skills/vtex-io-service-configuration-apps/SKILL.mdCopy the whole skill folder; for one project use .claude/skills/vtex-io-service-configuration-apps/
1Skills CLI (Vercel)
npx skills add vtex/skills --skill vtex-io-service-configuration-apps -a codex2Manually: put the files in place
.agents/skills/vtex-io-service-configuration-apps/SKILL.mdFor all projects use ~/.agents/skills/
1Skills CLI (Vercel)
npx skills add vtex/skills --skill vtex-io-service-configuration-apps -a cursor2Manually: put the files in place
.cursor/skills/vtex-io-service-configuration-apps/SKILL.mdCursor also reads .agents/skills/ and .claude/skills/
1GitHub CLI
gh skill install vtex/skills vtex-io-service-configuration-apps2Manually: put the files in place
.github/skills/vtex-io-service-configuration-apps/SKILL.md1Skills CLI (Vercel)
npx skills add vtex/skills --skill vtex-io-service-configuration-apps -a gemini-cli2Platform CLI
gemini skills install https://github.com/vtex/skills --path skills/vtex-io-service-configuration-appsManually: put the files in place
.devin/skills/vtex-io-service-configuration-apps/SKILL.mdThe legacy .windsurf/skills/ path still works
Skills CLI (Vercel)
npx skills add vtex/skills --skill vtex-io-service-configuration-apps -a opencodeClaude.ai
Zip the folder and upload it in Settings → Capabilities → Skills
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.