Appearance
Choose the right Agent SDK example
The examples progress from one-channel assistants to durable, event-driven workflows. Start with the smallest agent for your use case. Each guide explains its request flow, framework features, verification path, and reusable design.
The source projects live under examples/. Run the commands below from packages/agent-serve. See Run the CLI if the agent-sdk command isn't installed.
Compare the examples
| Agent | Runtime | Intake | Framework focus | What sets it apart |
|---|---|---|---|---|
| Weather agent | Local | HTTP and two Slack transports | Tools, stdio MCP, approvals, skill, subagent, schedule, hook, A/B, and evals | It demonstrates the broad local-runtime surface in one domain. |
| Slack agent | Local | Account-linked Slack | Channel identity, threads, and suggested prompts | It reaches Slack without authored tools. |
| Concierge | Local | Built-in HTTP | Peer MCP and multi-agent serving | It delegates to a separate agent with its own tools, sessions, and context. |
| Playbook router | Local with repo context | Two Slack transports | Channel watching, inherited skills, custom cwd, and an eval | An allowlisted Slack channel becomes an intake queue for repo playbooks. |
| Alert investigator | Local | Watched Slack alerts channel | Bot-post channel watching, per-thread debounce, reminder tools, and host Slack calls | Every alert gets a thread-pinned investigation that schedules its own re-checks. |
| PR evidence reviewer | Local | Custom HTTP and Slack | Host tool, skill, seeded workspaces, and an eval | The model receives a prepared diff-first evidence tree instead of a checkout. |
| Approval Buddy | Local | GitHub and Slack | Policy tools, two subagents, durable storage, and evals | Code decides whether a PR may be approved. Reviews stay informational. |
| Security Reviewer | Local host pipeline | GitHub and chat | Staged tools, parallel SDK agents, progress UI, durable storage, A/B, and evals | Lives in factory/security-reviewer/. Reviewers and triage overlap while the playground shows every stage. |
| Remote PR coordinator | Local coordinator and remote PR sessions | HTTP, GitHub, and Slack | Remote handoff, hooks, affinity, buffering, reminders, and workflow MCP | One remote conversation follows a PR across chat, webhooks, and timed wakes. |
| Knowledge base | Local | Built-in HTTP chat | Durable host-side state, a conventions skill, a schedule, unit tests, and evals | People curate shared facts in chat, and fresh sessions retrieve them from markdown. |
| Codebase wiki | Local | GitHub and chat | Task-dispatch webhooks, seeded digests, a mapping skill, a schedule, and evals | Merged PRs accumulate into per-feature wiki pages with a daily digest. |
| Codeowners review | Local | GitHub, chat, and fixtures | Ownership routing in code, playbook data files, parallel subagents, and evals | Each product area reviews with its own playbook, and verdicts aggregate mechanically. |
Pick a learning path
Use this order when you want to learn the Agent SDK one capability at a time:
- Start with Weather agent to explore the filesystem conventions and local runtime.
- Strip the project back to Slack agent to see the minimum channel surface.
- Read Playbook router when Slack should route requests into repo playbooks.
- Continue to Alert investigator when the intake is bot posts and the agent must pace its own engagement and re-checks.
- Add composition with Concierge.
- Study PR evidence reviewer before giving a model repository evidence.
- Move policy into code with Approval Buddy.
- Compare Security Reviewer and Remote PR coordinator for host-side versus remote PR work.
- See parallel subagent delegation carry team judgment in Codeowners review.
- Curate team context through conversation with Knowledge base, then let GitHub events maintain product documentation in Codebase wiki.
Common prerequisites
All examples require:
- Node 22.13 or newer. Don't run the Agent SDK under Bun.
- Workspace dependencies installed.
- An agent-runtime credential for model turns.
Several examples need more:
- Account-linked Slack channels require a connected host account.
- Alert investigator needs a dedicated Socket Mode app with channel-post events and membership in the watched alerts channel.
- GitHub examples require access to the target repository. Codebase wiki and Codeowners review call the host
ghCLI for PR data; the codeowners fixtures run without network. - Example agents use
cursorHostedStorage(agent/storage.ts) for Cursor-hosted session storage (control-plane proxy). - Remote PR coordinator starts remote agent sessions and needs access to its workflow backend.
Each guide lists its own credentials, services, and side effects.
Validate any example
Discovery commands don't start a model turn:
bash
agent-sdk validate --dir examples/weather-agent
agent-sdk info --dir examples/weather-agent --jsonStart one development server with agent-sdk dev examples/<name>. Concierge depends on Weather agent, so its guide creates an isolated two-project mount. Don't mount the whole examples directory to test one agent; several advanced examples subscribe to live GitHub events.
Read by framework feature
- Concepts explains filesystem discovery and runtime boundaries.
- Project layout lists every authored folder.
- Tools, channels, and MCP connections cover the core extension points.
- Evals and live A/B metrics cover measured iteration.
- Deployment covers credentials, auth, storage, and hosting.