vtex-io-app-contract

Validate VTEX IO manifest.json app contracts for builders and dependencies.

Updated Mar 27, 2026
One-click install
npx skills add https://github.com/exilonX/ap2 --skill vtex-io-app-contract-exilonx
Or copy as Structured Prompt for Agent
Please help me install this Agent Skill.
Skill: vtex-io-app-contract
Source: https://github.com/exilonX/ap2/tree/main/.agents/skills/vtex-io-app-contract
Command: npx skills add https://github.com/exilonX/ap2 --skill vtex-io-app-contract-exilonx

SYSTEM DOCUMENTATION & REQUIREMENTS

What problem does it solve?

It prevents broken VTEX IO app linking, publishing, and capability discovery by ensuring your manifest.json accurately declares the app identity, builders, dependencies, and billing boundaries.

Core Features & Use Cases

  • Contract-first validation: Aligns every shipped capability with a corresponding builder declaration in manifest.json so the platform compiles what you actually intend to ship.
  • Correct integration boundaries: Guides whether related apps belong in dependencies vs peerDependencies, especially around billingOptions and environment-managed apps.
  • Semver-safe identity hygiene: Ensures vendor/name/version remain publishable and stable so upgrades are predictable across workspaces and releases.
  • Use Cases: Scaffolding a new VTEX IO app, adjusting builders for capability changes, and fixing link/publish failures caused by manifest-level contract issues.

Quick Start

Apply this skill to review your VTEX IO manifest.json and decide exactly which builders, dependencies, peerDependencies, and billingOptions correctly reflect the app contract you intend to publish.

Frequently Asked Questions about vtex-io-app-contract

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

FAQPage Schema
How do I fix VTEX IO app link or publish failures caused by manifest.json?

Fix VTEX IO app link or publish failures by treating manifest.json as the single source of truth, enforcing builder-capability alignment, and validating semver-safe vendor/name/version identity. This resolves discrepancies between declared builders and shipped capabilities.

When do I use dependencies vs peerDependencies in a VTEX IO app contract?

Use dependencies vs peerDependencies in a VTEX IO app contract to define correct integration boundaries based on capability ownership. Choose peerDependencies for environment-managed apps and align dependencies with billingOptions to ensure proper installation boundaries.

What is builder-capability alignment in VTEX IO manifest.json?

Builder-capability alignment in VTEX IO manifest.json ensures every shipped capability corresponds to a declared builder. This contract-first validation guarantees the platform compiles exactly what you intend to ship, preventing broken app linking and publishing.

How do I scaffold a new VTEX IO app contract with correct billingOptions?

Scaffold a new VTEX IO app contract by defining manifest.json with semver-safe vendor/name/version, matching builders to capabilities, and setting billingOptions-consistent dependency modeling. This ensures predictable upgrades across workspaces and releases.

Why does my VTEX IO app publish fail due to invalid vendor/name/version?

VTEX IO app publish fails due to invalid vendor/name/version when manifest.json identity lacks semver-safe hygiene. Enforce stable, publishable identity fields to ensure upgrades remain predictable across workspaces and releases.

Can I adjust VTEX IO builders without breaking my existing app contract?

Adjust VTEX IO builders without breaking your app contract by updating manifest.json to maintain builder-capability alignment. Validate that dependency and peerDependency relationships still reflect correct integration boundaries and billingOptions consistency.