Documentation
Feedback
Guides
API Reference

Guides
Guides

VTEX Skills

Install AI agent skills that encode VTEX-specific patterns, constraints, and best practices into your AI coding assistant.

Source code

VTEX Skills is a catalog of AI agent skills for VTEX platform development, available as part of the VTEX AI Developer Toolkit.

The VTEX AI Developer Toolkit also includes the VTEX Developer MCP, which retrieves VTEX documentation and API references on demand. VTEX Skills and VTEX Developer MCP are complementary: VTEX Skills loads persistent platform context before a task starts, while the MCP provides live lookup.

A skill is a plain-text file that an AI agent loads as persistent context before generating code. In VTEX Skills, this context provides platform-specific guidance based on VTEX product knowledge and official documentation. Use skills to help agents follow VTEX patterns, constraints, and implementation requirements when working with VTEX projects.

VTEX Skills covers:

  • Platform constraints: Limits and requirements specific to the VTEX platform, such as rate limits, schema caps, and timeout windows.
  • APIs and parameters: Which APIs to call for a given use case and the parameters they expect.
  • Implementation patterns: Recommended approaches for common tasks, such as setting up a FastStore override, implementing a PPP endpoint, or configuring a Master Data entity.
  • Security requirements: VTEX-specific boundaries, including PCI scope and Secure Proxy usage.

Available skills

Skills are organized into tracks. Each track groups related skills for a VTEX development area, so the agent gets focused context for the task. You can install all tracks at once or select only the ones relevant to your project.

TrackDescription
Commerce architectureArchitecture guidance and solution design for VTEX projects
FastStoreOverrides, theming, SDK hooks, and data fetching for FastStore storefronts
Headless frontend developmentBFF architecture, Intelligent Search API, checkout proxy patterns, and caching strategy
MarketplaceSKU catalog sync, order hooks, fulfillment simulation, and rate limiting
PaymentPayment Provider Protocol endpoints, framework lifecycle, idempotency, async flows, and PCI compliance
Sales AppVTEX Sales App extension points (cart, PDP, menu), React hooks, TypeScript types, secure API integration patterns, code generation, validation, and deployment
VTEX IOApp foundations, API exposure, frontend, data and configuration, security, and operations for IO app development

The VTEX IO track covers the full lifecycle of VTEX IO app development. If you are building a new VTEX IO app, install this track first.

For the full skill catalog, per-track details, and contributing guide, see the VTEX Skills GitHub repository.

Installation

Installation with npx is recommended. It auto-detects the AI tools installed in your environment and places the skill files where each one expects them.


_10
npx skills add vtex/skills

Use --list to preview available skills, or --all to install all available skills without interactive prompts.

The installer supports tools such as Cursor, Claude Code, Codex, and OpenCode. To use VTEX Skills with Claude Projects, manually upload the skill files as described in the instructions below.

Manual installation

  • Claude Projects: Upload the files from exports/claude/ as project knowledge in your Claude Project settings.

  • AGENTS.md: Use this format for tools that support AGENTS.md, including Cursor, Copilot, Codex, Windsurf, Amp, and Devin.


    _10
    curl -sL https://github.com/vtex/skills/releases/latest/download/agents-md.tar.gz | tar xz -C your-project/

  • Cursor


    _10
    mkdir -p your-project/.cursor/rules
    _10
    curl -sL https://github.com/vtex/skills/releases/latest/download/cursor-rules.tar.gz | tar xz -C your-project/.cursor/rules/

  • GitHub Copilot


    _10
    mkdir -p your-project/.github
    _10
    curl -sL https://github.com/vtex/skills/releases/latest/download/copilot-instructions.tar.gz | tar xz -C your-project/.github/

  • OpenCode


    _10
    curl -sL https://github.com/vtex/skills/releases/latest/download/opencode-skills.tar.gz | tar xz -C ~/.config/opencode/skills/

  • Kiro: Clone the repository and copy the Kiro export files.


    _10
    git clone https://github.com/vtex/skills.git
    _10
    cp -r skills/exports/kiro/. your-project/

Versioning and updates

Skills are versioned and released alongside VTEX documentation updates. To update to the latest version, re-run the install command for your platform. The npx command always pulls the latest release.

If you installed via curl, check the releases page for changelogs before updating.

To avoid unexpected behavior from skill updates in CI environments, you can pin a specific version. Use npx skills add vtex/skills@<version> or reference a tagged release URL in your curl commands.

Contributors
3
Photo of the contributor
Photo of the contributor
Photo of the contributor
Was this helpful?
Yes
No
Suggest Edits (GitHub)
See also
VTEX AI Developer Toolkit
Guides
VTEX Developer MCP
Guides
Contributors
3
Photo of the contributor
Photo of the contributor
Photo of the contributor
Was this helpful?
Suggest edits (GitHub)
On this page