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

- 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-app-settings/SKILL.md
- Updated: 2026-10-14
- HTML: https://affpapa.org/en/nevibecode/skills/vtex-io-app-settings

## What it does

This skill tells the agent where configuration for a VTEX IO app should live. Values shared across the app or account go into `settingsSchema` and get edited in VTEX Admin. Anything that differs per page or block belongs in `store/contentSchemas.json`. The schema itself should be real JSON Schema with `properties`, `required`, `default`, `enum` and `format`, not a bare `type: object`.

On the backend, settings are fetched with `ctx.clients.apps.getAppSettings` and the app's own ID, and normalization plus defaults sit in one helper. API keys and other secrets stay server-side, out of responses and logs. A `format: password` hint lets some consumers mask a field, but the skill treats it as a bonus, not protection. Frontend code sees only fields marked `access: public`, through `publicSettingsForApp`.

If reading the app's own settings returns a 403, adding `read-workspace-apps` to the manifest is the wrong fix. For configuration shared between several apps, the skill points to a separate app on the `configuration` builder. It stays away from `service.json`, Master Data entity design and route auth.

## Install

### Claude Code (native platform)

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

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

### Codex

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

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

### Cursor

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

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

### GitHub Copilot

1. **GitHub CLI**
```bash
gh skill install vtex/skills vtex-io-app-settings
```

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

### Gemini CLI

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

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

### Windsurf (Devin Desktop)

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

### OpenCode

**Skills CLI (Vercel)**
```bash
npx skills add vtex/skills --skill vtex-io-app-settings -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-app-settings/SKILL.md

## When to use it
- write a settings schema with `required`, `default` and `enum`
- keep an external service API key away from frontend code
- decide between `settingsSchema` and `contentSchemas.json`
- expose harmless fields to the storefront via `publicSettingsForApp`
- centralize settings reads in one helper with fallback values

## Example prompts
- Write a `settingsSchema` for my VTEX IO app with a moderation toggle, a sandbox/production mode and an API key
- Check whether any route returns the raw app settings, key included
- Should this value go in `settingsSchema` or `contentSchemas.json`?

## 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