Skip to main content
skill CX Codex

vtex-io-graphql-api — Claude Code skill for GraphQL

Guides GraphQL schema and resolver work in VTEX IO apps. Use it when exposing app data through queries or mutations.

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

What vtex-io-graphql-api does

The skill covers schema files under graphql/ and resolver code in node/resolvers/. It helps define types, apply @cacheControl and @auth, and connect schema fields to resolvers in the Service entry point. It also calls out the graphql builder in manifest.json; without that declaration, the schema files are ignored.

Public queries need cache rules, while mutations and user-specific data need authentication checks. Resolver keys must correspond to schema field names, and resolvers should access data through ctx.clients. A mismatched key can leave a field returning null without an error in the logs.

What it helps with

  • define GraphQL schema fields and types
  • connect schema fields to resolver functions
  • set cache rules for public queries
  • require authentication for mutations and personal data
  • trace why a GraphQL schema is not loaded

Example prompts for the agent

  • Review the files in graphql/ and add suitable directives to the schema fields.
  • Connect the fields in schema.graphql to the Service resolvers and check their names.
  • Check manifest.json and add the graphql builder if this schema needs it.

How to install vtex-io-graphql-api

1Skills CLI (Vercel)

npx skills add vtex/skills --skill vtex-io-graphql-api -a claude-code

2Manually: put the files in place

~/.claude/skills/vtex-io-graphql-api/SKILL.md

Copy the whole skill folder; for one project use .claude/skills/vtex-io-graphql-api/

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

Questions about vtex-io-graphql-api

How do I install vtex-io-graphql-api in Claude Code?

Run npx skills add vtex/skills --skill vtex-io-graphql-api -a claude-code. The skill file is at ~/.claude/skills/vtex-io-graphql-api/SKILL.md.

What does vtex-io-graphql-api do?

It assists with GraphQL schemas and resolvers for VTEX IO apps, including cache directives and authentication rules.

Why does the app need the graphql builder in manifest.json?

The builder processes schema files in graphql/ and registers the schema with VTEX IO. Without it, the schema is not loaded.

Similar skills

All skills for Backend and APIs →

From the same set38

architecture-well-architected-commerce Reviews cross-cutting VTEX commerce architecture against three core pillars. It guides decisions between standard platform capabilities and custom extensions. CX Codex +1 1,200installs vtex-io-application-performance Guides performance work on VTEX IO Node and .NET services, including cache choices, parallel client calls, and avoiding repeated work. CX Codex +1 1,200installs vtex-io-app-settings Helps an agent define settingsSchema for a VTEX IO app and read the values safely in code. Useful when merchants should change app behavior themselves. CX Codex +1 1,200installs vtex-io-storefront-react Guides coding of shopper-facing VTEX IO React components. Enforces vtex.css-handles, localized strings, and storefront hooks while preventing Node-only runtime calls. CX Codex +1 1,200installs vtex-io-masterdata Walks you through Master Data v2 in VTEX IO apps and pushes back when the data belongs somewhere else. CX Codex +1 1,200installs vtex-io-service-apps Guides backend service development under node/ in VTEX IO apps. Configures routes, middleware chains, and @vtex/api clients for background tasks or APIs. CX Codex +1 1,200installs headless-caching-strategy Sets caching rules and TTL values for headless VTEX storefronts. Keeps public endpoints fast while preventing accidental caching of sensitive shopper data. CX Codex +1 1,100installs headless-intelligent-search Build VTEX Intelligent Search into a headless storefront, with facets, autocomplete and search analytics. Useful when a custom frontend needs product discovery. 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