vtex-io-service-configuration-apps

Define and inject shared configuration contracts across VTEX IO service apps.

39|9|Updated Mar 16, 2026
One-click install
npx skills add https://github.com/vtex/ai-skills --skill vtex-io-service-configuration-apps
Or copy as Structured Prompt for Agent
Please help me install this Agent Skill.
Skill: vtex-io-service-configuration-apps
Source: https://github.com/vtex/ai-skills/tree/main/tracks/vtex-io/skills/vtex-io-service-configuration-apps
Command: npx skills add https://github.com/vtex/ai-skills --skill vtex-io-service-configuration-apps

SYSTEM DOCUMENTATION & REQUIREMENTS

What problem does it solve?

Centralize and decouple runtime configuration for VTEX IO services by using shared, versioned configuration contracts that are injected rather than hard-coded.

Core Features & Use Cases

  • Establish configuration schemas via configuration/schema.json to define a stable contract across apps.
  • Expose configuration through a dedicated configuration app and opt-in in service manifests using settingsType or GraphQL @settings.
  • Enable cross-service sharing, versioning, and independent lifecycle of configuration from the consuming service.

Quick Start

Create a configuration app, declare configuration/schema.json, and wire the service to receive injected settings via settingsType or @settings.

Frequently Asked Questions about vtex-io-service-configuration-apps

High-intent search queries and answers about installing and using this skill.

FAQPage Schema
How do I share configuration across multiple VTEX IO service apps?

Share configuration across VTEX IO service apps by defining a versioned configuration schema and injecting settings via a dedicated configuration app. Consumers opt in through manifest.json using settingsType or GraphQL @settings, decoupling runtime configuration from service code.

What is the best way to decouple runtime settings from VTEX IO service code?

Decouple runtime settings from VTEX IO service code by establishing a shared configuration contract. Define a stable schema in configuration/schema.json, expose it through a configuration app, and inject values into services rather than hard-coding them.

How do I set up a configuration schema for VTEX IO apps?

Set up a configuration schema by creating a configuration app with a configuration/schema.json file that defines the contract. Add a matching configuration.json in the configuration/ folder and wire the service manifest to receive injected settings.

Do I need a configuration builder in manifest.json to inject VTEX IO settings?

Yes, injecting VTEX IO settings requires a service app declaring the configuration builder in its manifest.json. The service then explicitly opts in to the shared contract using settingsType or GraphQL @settings entries.

Why use shared configuration contracts instead of hard-coded settings in VTEX IO?

Shared configuration contracts enable cross-service sharing, versioning, and independent lifecycle management of configuration separate from the consuming service. This prevents configuration drift and removes the need to deploy service code changes for setting updates.

Can I version and update VTEX IO service configuration independently?

Yes, VTEX IO service configuration supports independent lifecycle and versioning. By centralizing settings in a dedicated configuration app with a defined schema, you can update and version configuration without redeploying the consuming service code.