Vercel Eve Framework

Status: Public beta — launched June 17, 2026. File conventions and APIs may change. License: Apache-2.0 | npm: eve | GitHub: github.com/vercel/eve

Ground Rules (Read Before Acting)

These apply to every response involving Eve:

1. Never fabricate Eve APIs. If a method, option, or file convention isn't in this skill

or the bundled docs, say "I'm not certain — check node_modules/eve/docs" rather than inventing it.

1. Bundled docs are authoritative. After install they live at node_modules/eve/docs.

When this skill and the bundled docs conflict, the bundled docs win.

1. Version-aware responses. This skill targets the public beta. Always note when advice

may shift before GA, and direct users to github.com/vercel/eve/releases for the changelog.

1. Shell safety. Before running any bash command in a sandbox or dev environment:

— Prefer targeted file edits over shell commands when they're sufficient. — Explain the effect of destructive or network-installing commands before running them. — Never embed credentials in commands, flags, or output.

What Eve Is

Eve is a filesystem-first framework for durable backend AI agents. The core contract: an agent is a directory of files. The directory is the definition.

Adding a capability means adding a file. Eve discovers it at build time. No boilerplate.

Minimal Working Agent

Two files. That's the entire agent.

// agent/agent.ts
import { defineAgent } from 'eve';
export default defineAgent({
  model: 'anthropic/claude-opus-4.8', // '<provider>/<model>' resolves via AI Gateway
});

<!-- agent/instructions.md -->
You are a concise assistant. Use tools when they are available.

CLI Quick-Reference

Beta usage: eve@latest gets current releases. Review github.com/vercel/eve/releases before any upgrade — beta releases may contain breaking changes.

Reference File Routing

Load only the file that matches the current query. Do not preload all references.

Import Quick-Reference

import { defineAgent } from 'eve';                          // agent/agent.ts
import { defineTool } from 'eve/tools';                     // agent/tools/*.ts
import { defineSandbox } from 'eve/sandbox';                // agent/sandbox/sandbox.ts
import { defineSlackChannel } from 'eve/channels/slack';   // Slack channel
import { defineChannel } from 'eve/channels';               // custom channels
import { defineMcpClientConnection } from 'eve/connections'; // MCP connection
import { defineApiConnection } from 'eve/connections';      // OpenAPI connection
import { defineSchedule } from 'eve/schedules';             // agent/schedules/*.ts
import { defineEval } from 'eve/evals';                     // evals/*.eval.ts
import { includes, not, matches, contains } from 'eve/evals/expect';
import { z } from 'zod';                                    // always use for inputSchema

Coding-Agent Bootstrap Prompt

Paste this into any coding agent (Claude Code, Cursor, Windsurf) to scaffold an Eve project:

Set up an Eve agent. Eve is a filesystem-first TypeScript framework for durable agents,
published as the npm package `eve` (Apache-2.0).

BEFORE ACTING: Read bundled docs at node_modules/eve/docs (post-install). Pre-install:
read vercel.com/docs/eve and vercel.com/blog/introducing-eve.

SCAFFOLD: npx eve@latest init <name>
  — Add --channel-web-nextjs ONLY if the user explicitly asked for a web chat UI.
  — init installs deps, starts a dev server. Run in a controllable process; stop before editing.
To add to an existing project: npm install eve@latest

ENSURE these exist: agent/agent.ts (defineAgent with a model string) + agent/instructions.md

ADD a first typed tool at agent/tools/get_weather.ts:
  — Use defineTool from eve/tools
  — Use Zod for inputSchema
  — Return a plain JSON-serialisable value from execute()

VERIFY: pnpm typecheck (or tsc --noEmit). Fix all type errors before proceeding.

EXERCISE the HTTP API:
  POST   /eve/v1/session              — create session, capture sessionId + continuationToken
  GET    /eve/v1/session/:id/stream   — attach to NDJSON stream
  POST   /eve/v1/session/:id/message  — send follow-up with continuationToken header

RULES:
  — Never invent Eve APIs. If uncertain, read node_modules/eve/docs and say so.
  — Do not commit unless the user explicitly asks.
  — Shell commands: explain destructive effects before running; never expose credentials.