queues — Vercel skill for Claude Code
Learn how to use Vercel Queues for background work, message buffering, and event fan-out. The skill also helps decide when Workflows fit better.
Apache-2.0 178 installs ★ 344 updated 2026-11-16
npx skills add vercel/vercel-plugin --skill queues -a claude-codeWhat queues does
The skill covers Vercel Queues topics, consumer groups, and message delivery with retries. It explains where queues fit for background jobs or distributing events, and when to use Workflows for logic that spans multiple durable steps.
Its examples use send() from @vercel/queue, a handleCallback() consumer, and experimentalTriggers in vercel.json. Consumers need idempotent handlers because a message can be delivered more than once. For local development, run vercel link and vercel env pull first; otherwise the SDK cannot authenticate.
What it helps with
- defer a background job to a queue
- send an event to independent consumer groups
- retry message processing after a failure
- choose between Queues and Workflows
Example prompts for the agent
- Show me how to send a background job with Vercel Queues.
- Write a queue consumer with
handleCallback()and register it invercel.json. - Compare Queues and Workflows for multi-step event processing.
How to install queues
1Skills CLI (Vercel)
npx skills add vercel/vercel-plugin --skill queues -a claude-code2Manually: put the files in place
~/.claude/skills/queues/SKILL.mdCopy the whole skill folder; for one project use .claude/skills/queues/
1Skills CLI (Vercel)
npx skills add vercel/vercel-plugin --skill queues -a codex2Manually: put the files in place
.agents/skills/queues/SKILL.mdFor all projects use ~/.agents/skills/
1Skills CLI (Vercel)
npx skills add vercel/vercel-plugin --skill queues -a cursor2Manually: put the files in place
.cursor/skills/queues/SKILL.mdCursor also reads .agents/skills/ and .claude/skills/
1GitHub CLI
gh skill install vercel/vercel-plugin skills/queues2Manually: put the files in place
.github/skills/queues/SKILL.md1Skills CLI (Vercel)
npx skills add vercel/vercel-plugin --skill queues -a gemini-cli2Platform CLI
gemini skills install https://github.com/vercel/vercel-plugin --path skills/queuesManually: put the files in place
.devin/skills/queues/SKILL.mdThe legacy .windsurf/skills/ path still works
Skills CLI (Vercel)
npx skills add vercel/vercel-plugin --skill queues -a opencodeClaude.ai
Zip the folder and upload it in Settings → Capabilities → Skills
Step by step, with commands for each platform: How to install skills in Claude Code: five ways
Questions about queues
How do I install queues in Claude Code?
Run npx skills add vercel/vercel-plugin --skill queues -a claude-code. The skill file is at ~/.claude/skills/queues/SKILL.md.
What does the queues skill do?
It guides you through using Vercel Queues for background processing and message delivery, and helps you choose between Queues and Workflows.
What do I need for local Vercel Queues development?
Run vercel link and vercel env pull before local development so the SDK can authenticate. Consumer handlers should account for messages being delivered more than once.
Source text
SKILL.md · Apache-2.0
---
name: queues
description: Vercel Queues guidance — durable topics with at-least-once delivery, independent consumer groups, retries, delays, and idempotency keys via @vercel/queue (JS) or vercel-queue (Python). Use when deferring background work, buffering traffic, fanning out events, or choosing between Queues and Workflows.
summary: "Vercel Queues (beta) publishes JSON messages to durable topics with `send()` from `@vercel/queue`; consumers are Vercel Functions exported with `handleCallback()` and registered in vercel.json under `functions.<path>.experimentalTriggers` as `{ type: 'queue/v2beta', topic: '<name>' }`. Delivery is at-least-once with automatic retries; use Workflows instead for multi-step durable logic."
metadata:
priority: 6
docs:
- "https://vercel.com/docs/queues"
- "https://vercel.com/docs/queues/sdk"
sitemap: "https://vercel.com/sitemap.xml"
pathPatterns:
- 'app/api/queues/**'
- 'src/app/api/queues/**'
- 'pages/api/queues/**'
- 'lib/queue.*'
- 'src/lib/queue.*'
- 'lib/queues/**'
- 'src/lib/queues/**'
bashPatterns:
- '\bnpm\s+(install|i|add)\s+[^\n]*@vercel/queue\b'
- '\bpnpm\s+(install|i|add)\s+[^\n]*@vercel/queue\b'
- '\bbun\s+(install|i|add)\s+[^\n]*@vercel/queue\b'
- '\byarn\s+add\s+[^\n]*@vercel/queue\b'
- '\b(pip|uv)\s+(install|add)\s+[^\n]*vercel-queue\b'
importPatterns:
- "@vercel/queue"
promptSignals:
phrases:
- "vercel queues"
- "@vercel/queue"
- "background job"
- "background jobs"
- "message queue"
- "job queue"
- "consumer group"
allOf:
- [vercel, queues]
- [queue, topic]
- [queue, consumer]
- [queue, buffer]
- [fan, out]
anyOf:
- "queue"
- "topic"
- "retry"
- "consumer"
- "buffer"
- "background"
noneOf:
- "build queue"
- "deployment queue"
- "queued deployment"
- "deployments stuck"
- "queues up deployments"
- "queue up deployments"
- "queues my deployments"
- "queues our deployments"
- "queues your deployments"
- "queues the deployments"
- "queues deployments"
- "queues builds"
- "queues my builds"
minScore: 6
retrieval:
aliases:
- queues
- message queue
- background jobs
- event streaming
- pub sub
intents:
- defer work to a queue
- process background jobs
- fan out events to consumers
- retry failed jobs
- buffer traffic spikes
entities:
- Vercel Queues
- "@vercel/queue"
- topic
- consumer group
- handleCallback
- experimentalTriggers
chainTo:
-
pattern: '"use workflow"|"use step"|from\s+[''"]workflow[''"]'
targetSkill: workflow
message: 'Workflow SDK code alongside Queues — Workflows is built on Queues and adds durable steps, sleep, and hooks. Loading Workflow guidance.'
-
pattern: 'from\s+[''"](bullmq|bull|bee-queue|agenda)[''"]|@aws-sdk/client-sqs'
targetSkill: queues
message: 'Third-party job queue detected — Vercel Queues provides durable topics with retries and fan-out without running a broker. Loading Queues guidance.'
skipIfFileContains: '@vercel/queue'
---
# Vercel Queues
You are an expert in Vercel Queues, the durable message topics that power background work and agent events on Vercel.
## What It Is
Vercel Queues (public beta) gives you durable, append-only topics. Producers publish JSON messages, and every subscribed consumer group receives every message with at-least-once delivery and automatic retries. New consumer groups can join later and replay non-expired history. Queues is the primitive under Vercel Workflows; use Queues directly when you need control over publishing, consumption, and routing.
- **Topic**: a named durable log of messages, created on first publish
- **Consumer group**: an independent subscriber that receives every message on a topic
- **Delivery**: at-least-once; handlers must be idempotent
- **Retention**: 24 hours by default, up to 7 days; delivery can be delayed up to the retention period
- **Modes**: push (Vercel invokes your function) or poll (your own workers pull messages from any environment)
## Choose Queues or Workflows
| Need | Use | Why |
|------|-----|-----|
| Fire-and-forget background job, fan-out, buffering | **Queues** | Direct publish/consume, independent consumer groups |
| Multi-step logic with sleep, hooks, or human approval | **Workflows** (`⤳ skill: workflow`) | Durable steps and replay built on top of Queues |
| Scheduled invocation on a cron or once at a set time | Vercel Schedules (`⤳ skill: vercel-schedules`); a schedule can publish to a queue topic | Time-based trigger, not message-based; beta, replaces legacy Cron Jobs |
## Quickstart (Next.js App Router)
Install the SDK:
```bash
npm install @vercel/queue
```
Publish from any route, Server Action, or function:
```ts
// app/api/orders/route.ts
import { send } from '@vercel/queue';
export async function POST(request: Request) {
const body = await request.json();
const { messageId } = await send('orders', { orderId: body.orderId, action: 'process' });
return Response.json({ messageId });
}
```
Consume with a push-mode handler. Messages are acknowledged when the handler returns and retried when it throws:
```ts
// app/api/queues/process-order/route.ts
import { handleCallback } from '@vercel/queue';
export const POST = handleCallback(async (message, metadata) => {
await processOrder(message);
console.log('processed', metadata.messageId, 'delivery', metadata.deliveryCount);
});
```
Register the consumer in `vercel.json` (or `vercel.ts`) so Vercel routes the topic to that function:
```json filename="vercel.json"
{
"functions": {
"app/api/queues/process-order/route.ts": {
"experimentalTriggers": [{ "type": "queue/v2beta", "topic": "orders" }]
}
}
}
```
Run `vercel link` and `vercel env pull` before local development so the SDK can authenticate.
## Send Options
```ts
await send('orders', payload, {
region: 'sfo1', // target a specific region
retentionSeconds: 3600, // message TTL; min 60, max 604800 (7 days); default 24 hours
delaySeconds: 60, // delay first delivery; max 7 days, capped at the TTL
idempotencyKey: 'order-123', // duplicates within min(retention, 24 hours) are dropped
headers: { 'x-trace-id': 'abc-123' },
});
```
Create a `QueueClient` when you need defaults, a fixed region, or multiple clients:
```ts
// lib/queue.ts
import { QueueClient } from '@vercel/queue';
const queue = new QueueClient({ region: 'sfo1' });
export const { send, handleCallback } = queue;
```
## Consumer Options and Retries
`handleCallback(handler, options)` accepts:
| Option | Default | Notes |
|--------|---------|-------|
| `visibilityTimeoutSeconds` | 300 | How long a message stays in flight; the SDK re-extends the lease while the handler runs |
| `retry` | trigger `retryAfterSeconds` (60s) | `(error, metadata) => { afterSeconds } \| { acknowledge: true } \| undefined` |
Handle poison messages by acknowledging after a delivery-count threshold:
```ts
export const POST = handleCallback(processOrder, {
retry: (error, metadata) => {
if (metadata.deliveryCount > 5) return { acknowledge: true }; // stop retrying
return { afterSeconds: Math.min(300, 2 ** metadata.deliveryCount * 5) };
},
});
```
`metadata` includes `messageId`, `deliveryCount`, `createdAt`, `expiresAt`, `topicName`, `consumerGroup`, and `region`.
For Express, Connect, or Next.js Pages Router handlers use `queue.handleNodeCallback(async (message, metadata) => ...)` from a `QueueClient` instance, which takes `(req, res)`.
## Other Runtimes and Frameworks
- **Python**: `vercel-queue` publishes and consumes with the same topic model, and FastAPI, Flask, and Django apps can use it; Celery and Dramatiq integrations are documented under the Python backend frameworks.
- **Nitro / Nuxt**: declare `vercel.queues.triggers` in `nitro.config.ts` and handle messages with the `vercel:queue` runtime hook; `send` from `@vercel/queue` works in any server route.
- **Poll mode**: pull messages from your own workers in any environment when push delivery to a Vercel Function does not fit. On Vercel, run an always-on poll-mode consumer as a daemon (`⤳ skill: daemons`).
- **Payloads**: JSON by default; use `BufferTransport` for binary or `StreamTransport` for large bodies when constructing a `QueueClient`.
## Errors
`@vercel/queue` exports typed errors: `UnauthorizedError`, `BadRequestError`, and `MessageNotFoundError`. `QueueEmptyError` is exported but never thrown; an empty poll-mode `receive` returns `{ ok: false, reason: 'empty' }`. Duplicate idempotency keys do not throw; the duplicate is silently dropped.
## Common Pitfalls
1. **Missing trigger**: a `handleCallback` route with no `experimentalTriggers` entry never receives messages. Register every consumer in `vercel.json`/`vercel.ts`.
2. **Non-idempotent handlers**: delivery is at-least-once. Key side effects on `metadata.messageId` or your own `idempotencyKey`.
3. **Retrying forever**: without a `retry` policy that acknowledges poison messages or a trigger `maxDeliveries` cap, a permanently failing message is redelivered until it expires.
4. **Using Queues for multi-step logic**: if you need sleep, hooks, or approvals between steps, use Workflows instead of chaining topics by hand.
5. **Local dev without credentials**: run `vercel link` and `vercel env pull` first; otherwise `send()` throws `Failed to get OIDC token for local development`.
## References
- 📖 docs: https://vercel.com/docs/queues
- 📖 JS SDK: https://vercel.com/docs/queues/sdk
- 📖 Python SDK: https://vercel.com/docs/queues/python-sdk
- 📖 poll mode: https://vercel.com/docs/queues/poll-mode
- 📖 pricing and limits: https://vercel.com/docs/queues/pricing
© vercel · Apache-2.0 · vercel/vercel-plugin