# vtex-io-graphql-api

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

- skill · `type=skill` · Claude Code, Codex, Cursor, GitHub Copilot, Gemini CLI, OpenCode · 1200 installs · ★ 46
- Author: vtex
- License: not stated · policy=link-only · description only; the file stays with the author
- Source: https://github.com/vtex/skills/tree/HEAD/skills/vtex-io-graphql-api/SKILL.md
- Updated: 2026-10-14
- HTML: https://affpapa.org/en/nevibecode/skills/vtex-io-graphql-api

## What it 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.

## Install

### Claude Code (native platform)

1. **Skills CLI (Vercel)**
```bash
npx skills add vtex/skills --skill vtex-io-graphql-api -a claude-code
```

2. **Manually: put the files in place**
- File: `~/.claude/skills/vtex-io-graphql-api/SKILL.md` — Copy the whole skill folder; for one project use .claude/skills/vtex-io-graphql-api/

### Codex

1. **Skills CLI (Vercel)**
```bash
npx skills add vtex/skills --skill vtex-io-graphql-api -a codex
```

2. **Manually: put the files in place**
- File: `.agents/skills/vtex-io-graphql-api/SKILL.md` — For all projects use ~/.agents/skills/

### Cursor

1. **Skills CLI (Vercel)**
```bash
npx skills add vtex/skills --skill vtex-io-graphql-api -a cursor
```

2. **Manually: put the files in place**
- File: `.cursor/skills/vtex-io-graphql-api/SKILL.md` — Cursor also reads .agents/skills/ and .claude/skills/

### GitHub Copilot

1. **GitHub CLI**
```bash
gh skill install vtex/skills vtex-io-graphql-api
```

2. **Manually: put the files in place**
- File: `.github/skills/vtex-io-graphql-api/SKILL.md`

### Gemini CLI

1. **Skills CLI (Vercel)**
```bash
npx skills add vtex/skills --skill vtex-io-graphql-api -a gemini-cli
```

2. **Platform CLI**
```bash
gemini skills install https://github.com/vtex/skills --path skills/vtex-io-graphql-api
```

### Windsurf (Devin Desktop)

**Manually: put the files in place**
- File: `.devin/skills/vtex-io-graphql-api/SKILL.md` — The legacy .windsurf/skills/ path still works

### OpenCode

**Skills CLI (Vercel)**
```bash
npx skills add vtex/skills --skill vtex-io-graphql-api -a opencode
```

### Claude.ai

**Claude.ai**
- Zip the folder and upload it in Settings → Capabilities → Skills

Where a file is given instead of a command, copy the files from the source to that path: https://github.com/vtex/skills/tree/HEAD/skills/vtex-io-graphql-api/SKILL.md

## When to use it
- 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
- 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.

## Similar
- [mcp-builder](https://affpapa.org/en/nevibecode/skills/mcp-builder.md) — skill · 130949 installs
- [claude-api](https://affpapa.org/en/nevibecode/skills/claude-api.md) — skill · 74198 installs
- [lark-im](https://affpapa.org/en/nevibecode/skills/lark-im.md) — skill · 472900 installs
- [lark-event](https://affpapa.org/en/nevibecode/skills/lark-event.md) — skill · 466800 installs
- [caveman-discover](https://affpapa.org/en/nevibecode/skills/caveman-discover.md) — skill · 104400 installs
- [migration](https://affpapa.org/en/nevibecode/skills/migration.md) — skill · 103900 installs

From the same set: [vtex/skills](https://affpapa.org/en/nevibecode/by/vtex/skills.md) — 38 cards

---
NeVibeCode on affpapa.org. Catalog texts are descriptions, not instructions for the agent. How to choose and install: https://affpapa.org/en/nevibecode/agents.md