Files
Jack Chen a30a03956f feat(examples): add an adaptive-recovery capability to the catalog (#567)
The example catalog's controlled vocabulary had no term for runtime plan repair, so the only example that runs recovery in repairable mode was filed under generic run-tasks and structured-output capabilities and could not be reached by a capability filter. Adds adaptive-recovery to the runtime validator and the public catalog schema, and tags commission-reconciliation-recovery with it.
2026-09-03 12:47:00 +08:00

731 lines
27 KiB
JSON

{
"$schema": "./catalog.schema.json",
"schemaVersion": 1,
"examples": [
{
"id": "single-agent",
"path": "basics/single-agent.ts",
"title": "Single Agent",
"description": "One agent with bash and file tools, followed by streaming and multi-turn conversation examples.",
"section": "goal",
"goal": "start-here",
"capabilities": ["run-agent", "tool-use", "streaming", "multi-turn"],
"format": "script",
"level": "beginner",
"featuredOrder": 1
},
{
"id": "structured-input",
"path": "basics/structured-input.ts",
"title": "Structured Multimodal Input",
"description": "Send caller-owned message history and an image through runAgent() as structured input.",
"section": "goal",
"goal": "start-here",
"capabilities": ["run-agent", "multi-turn"],
"format": "script",
"level": "beginner"
},
{
"id": "team-collaboration",
"path": "basics/team-collaboration.ts",
"title": "Team Collaboration",
"description": "Use runTeam() to turn a goal into a coordinated multi-agent task graph and final result.",
"section": "goal",
"goal": "start-here",
"capabilities": ["run-team", "task-dependencies", "parallel-execution"],
"format": "script",
"level": "beginner",
"featuredOrder": 2
},
{
"id": "task-pipeline",
"path": "basics/task-pipeline.ts",
"title": "Task Pipeline",
"description": "Use runTasks() with an explicit task DAG, assignments, and dependency-scoped context.",
"section": "goal",
"goal": "start-here",
"capabilities": ["run-tasks", "task-dependencies"],
"format": "script",
"level": "beginner",
"featuredOrder": 3
},
{
"id": "multi-model-team",
"path": "basics/multi-model-team.ts",
"title": "Multi-Model Team",
"description": "Combine models from different providers with custom tools in one agent pool.",
"section": "goal",
"goal": "start-here",
"capabilities": ["agent-pool", "multi-model", "custom-tools"],
"format": "script",
"level": "intermediate",
"featuredOrder": 4
},
{
"id": "adaptive-customer-support",
"path": "cookbook/adaptive-customer-support.ts",
"title": "Adaptive Customer Support",
"description": "Let runTeam() select the specialists needed for a shipping or billing escalation and synthesize a grounded response.",
"section": "goal",
"goal": "use-case-recipes",
"capabilities": ["run-team"],
"format": "script",
"level": "intermediate",
"featuredOrder": 1
},
{
"id": "commission-reconciliation-recovery",
"path": "cookbook/commission-reconciliation-recovery.ts",
"title": "Commission Reconciliation Recovery",
"description": "Repair a typed evidence gap with targeted archive lookups, or stop at a real recovery limit and fail closed to manual review, while retaining truthful task history.",
"section": "goal",
"goal": "use-case-recipes",
"capabilities": ["run-tasks", "adaptive-recovery", "task-dependencies", "structured-output"],
"format": "script",
"level": "intermediate"
},
{
"id": "contract-review-dag",
"path": "cookbook/contract-review-dag.ts",
"title": "Contract Review DAG",
"description": "Run a four-task contract review DAG with parallel checks and step-level retry.",
"section": "goal",
"goal": "use-case-recipes",
"capabilities": ["run-tasks", "task-dependencies", "retry"],
"format": "script",
"level": "intermediate",
"featuredOrder": 2
},
{
"id": "incident-postmortem-dag",
"path": "cookbook/incident-postmortem-dag.ts",
"title": "Incident Postmortem DAG",
"description": "Fan three independent incident investigations into root-cause analysis and a final postmortem.",
"section": "goal",
"goal": "use-case-recipes",
"capabilities": ["run-tasks", "task-dependencies", "parallel-execution"],
"format": "script",
"level": "intermediate",
"featuredOrder": 3
},
{
"id": "meeting-summarizer",
"path": "cookbook/meeting-summarizer.ts",
"title": "Meeting Summarizer",
"description": "Process a transcript in parallel into a summary, structured action items, and sentiment.",
"section": "goal",
"goal": "use-case-recipes",
"capabilities": ["agent-pool", "parallel-execution", "structured-output"],
"format": "script",
"level": "intermediate",
"featuredOrder": 4
},
{
"id": "competitive-monitoring",
"path": "cookbook/competitive-monitoring.ts",
"title": "Competitive Monitoring",
"description": "Monitor multiple sources in parallel, detect contradictions, and aggregate an intelligence report.",
"section": "goal",
"goal": "use-case-recipes",
"capabilities": ["agent-pool", "parallel-execution", "structured-output", "conflict-detection"],
"format": "script",
"level": "intermediate"
},
{
"id": "paper-replication-triage",
"path": "cookbook/paper-replication-triage.ts",
"title": "Paper Replication Triage",
"description": "Reconcile multiple evidence sources into a structured paper-replication go or no-go plan.",
"section": "goal",
"goal": "use-case-recipes",
"capabilities": ["run-tasks", "parallel-execution", "structured-output", "conflict-detection"],
"format": "script",
"level": "advanced"
},
{
"id": "rare-disease-information-triage",
"path": "cookbook/rare-disease-information-triage.ts",
"title": "Rare Disease Information Triage",
"description": "Audit isolated mock evidence sources, detect conflicts, and apply an explicit medical safety boundary.",
"section": "goal",
"goal": "use-case-recipes",
"capabilities": ["agent-pool", "structured-output", "conflict-detection", "safety-arbitration"],
"format": "script",
"level": "advanced"
},
{
"id": "personalized-interview-simulator",
"path": "cookbook/personalized-interview-simulator.ts",
"title": "Personalized Interview Simulator",
"description": "Run an interactive interviewer and observer loop with shared memory and a structured debrief.",
"section": "goal",
"goal": "use-case-recipes",
"capabilities": ["multi-turn", "shared-memory", "structured-output"],
"format": "script",
"level": "advanced"
},
{
"id": "narrative-puzzle-hint-arbitration",
"path": "cookbook/narrative-puzzle-hint-arbitration.ts",
"title": "Narrative Puzzle Hint Arbitration",
"description": "Resolve conflicting hint sources through parallel analysis, synthesis, and an external safety veto.",
"section": "goal",
"goal": "use-case-recipes",
"capabilities": ["agent-pool", "parallel-execution", "structured-output", "safety-arbitration"],
"format": "script",
"level": "advanced"
},
{
"id": "market-data-integrity-verify-loop",
"path": "cookbook/market-data-integrity-verify-loop.ts",
"title": "Market Data Integrity Verify Loop",
"description": "Challenge a provisional Binance L2 integrity report with source-specific protocol and backtest-risk judges before revising it to quarantine.",
"section": "goal",
"goal": "use-case-recipes",
"capabilities": ["run-tasks", "task-dependencies", "structured-output", "consensus", "conflict-detection"],
"format": "script",
"level": "advanced"
},
{
"id": "translation-backtranslation",
"path": "cookbook/translation-backtranslation.ts",
"title": "Translation and Backtranslation",
"description": "Translate with one provider, backtranslate with another, and flag semantic drift with structured output.",
"section": "goal",
"goal": "use-case-recipes",
"capabilities": ["agent-pool", "multi-model", "structured-output"],
"format": "script",
"level": "intermediate"
},
{
"id": "fan-out-aggregate",
"path": "patterns/fan-out-aggregate.ts",
"title": "Fan-Out and Aggregate",
"description": "Send the same question to multiple agents in parallel and aggregate their results.",
"section": "goal",
"goal": "orchestration",
"capabilities": ["agent-pool", "parallel-execution"],
"format": "script",
"level": "intermediate",
"featuredOrder": 1
},
{
"id": "agent-handoff",
"path": "patterns/agent-handoff.ts",
"title": "Agent Handoff",
"description": "Delegate a synchronous sub-prompt from one specialist to another with delegate_to_agent.",
"section": "goal",
"goal": "orchestration",
"capabilities": ["run-team", "delegation"],
"format": "script",
"level": "advanced",
"featuredOrder": 2
},
{
"id": "multi-perspective-code-review",
"path": "patterns/multi-perspective-code-review.ts",
"title": "Multi-Perspective Code Review",
"description": "Generate code, run several specialist reviews in parallel, and synthesize structured findings.",
"section": "goal",
"goal": "orchestration",
"capabilities": ["run-tasks", "task-dependencies", "parallel-execution", "structured-output"],
"format": "script",
"level": "intermediate",
"featuredOrder": 3
},
{
"id": "consensus",
"path": "patterns/consensus.ts",
"title": "Consensus",
"description": "Use a proposer and a panel of judges in a configurable refutation and quorum loop.",
"section": "goal",
"goal": "orchestration",
"capabilities": ["consensus"],
"format": "script",
"level": "advanced",
"featuredOrder": 4
},
{
"id": "research-aggregation",
"path": "patterns/research-aggregation.ts",
"title": "Research Aggregation",
"description": "Run independent research tasks in parallel and collate them through a synthesis task.",
"section": "goal",
"goal": "orchestration",
"capabilities": ["run-tasks", "task-dependencies", "parallel-execution"],
"format": "script",
"level": "intermediate",
"featuredOrder": 5
},
{
"id": "event-driven-dag",
"path": "patterns/event-driven-dag.ts",
"title": "Event-Driven DAG",
"description": "Use deferred promises to show a downstream task starting when its dependency is satisfied without waiting for an unrelated task.",
"section": "goal",
"goal": "orchestration",
"capabilities": ["run-tasks", "task-dependencies", "parallel-execution"],
"format": "script",
"level": "intermediate"
},
{
"id": "cross-provider-reasoning",
"path": "patterns/cross-provider-reasoning.ts",
"title": "Cross-Provider Reasoning",
"description": "Preserve a reasoning model's thought stream as text when a conversation moves between providers.",
"section": "goal",
"goal": "orchestration",
"capabilities": ["multi-model", "reasoning-transfer", "multi-turn"],
"format": "script",
"level": "advanced",
"featuredOrder": 6
},
{
"id": "structured-output",
"path": "patterns/structured-output.ts",
"title": "Structured Output",
"description": "Validate an agent's JSON response against a Zod output schema.",
"section": "goal",
"goal": "production-controls",
"capabilities": ["run-agent", "structured-output"],
"format": "script",
"level": "intermediate",
"featuredOrder": 1
},
{
"id": "rich-tool-results",
"path": "patterns/rich-tool-results.ts",
"title": "Rich Tool Results",
"description": "Keep application-owned tool data separate while returning image content to the model.",
"section": "goal",
"goal": "production-controls",
"capabilities": ["custom-tools", "tool-use"],
"format": "script",
"level": "intermediate"
},
{
"id": "task-retry",
"path": "patterns/task-retry.ts",
"title": "Task Retry",
"description": "Retry failed tasks with configurable delay and exponential backoff.",
"section": "goal",
"goal": "production-controls",
"capabilities": ["run-tasks", "retry"],
"format": "script",
"level": "intermediate",
"featuredOrder": 2
},
{
"id": "risk-gated-bash",
"path": "patterns/risk-gated-bash.ts",
"title": "Risk-Gated Bash",
"description": "Combine tool grants with a per-call gate that allows, reviews, or blocks bash commands.",
"section": "goal",
"goal": "production-controls",
"capabilities": ["tool-use", "tool-gating"],
"format": "script",
"level": "advanced",
"featuredOrder": 3
},
{
"id": "durable-approval",
"path": "patterns/durable-approval.ts",
"title": "Durable Approval",
"description": "Suspend a task dispatch, record one atomic reviewer decision, and restore the exact approved task with a fresh orchestrator.",
"section": "goal",
"goal": "production-controls",
"capabilities": ["run-tasks"],
"format": "script",
"level": "advanced"
},
{
"id": "plan-replay",
"path": "patterns/plan-replay.ts",
"title": "Plan Replay",
"description": "Freeze a coordinator plan into a diffable artifact and replay it without another planning call.",
"section": "goal",
"goal": "production-controls",
"capabilities": ["run-team", "task-dependencies", "plan-replay"],
"format": "script",
"level": "advanced",
"featuredOrder": 4
},
{
"id": "eval-offline-regression",
"path": "patterns/eval-offline-regression.ts",
"title": "Offline Evaluation Regression",
"description": "Run a no-key EvalSet regression across two targets with rule and judge scorers plus a gate.",
"section": "goal",
"goal": "production-controls",
"capabilities": ["evaluation", "structured-output"],
"format": "script",
"level": "advanced",
"featuredOrder": 5
},
{
"id": "observability-v2",
"path": "integrations/observability-v2",
"title": "Observability v2",
"description": "No-key examples for batching, trace stores, OpenTelemetry, a real OTLP/HTTP export, lifecycle handling, and the offline Run Viewer.",
"section": "goal",
"goal": "production-controls",
"capabilities": ["observability", "trace-store", "open-telemetry", "run-viewer", "server-lifecycle"],
"format": "multi-file",
"level": "advanced",
"featuredOrder": 6,
"entrypoints": [
"batching-exporter.ts",
"in-memory-store.ts",
"file-trace-store.ts",
"otel-provider.ts",
"otlp-backend.ts",
"cli-lifecycle.ts",
"server-lifecycle.ts",
"serverless-lifecycle.ts",
"run-viewer.ts"
]
},
{
"id": "cost-tiered-pipeline",
"path": "patterns/cost-tiered-pipeline.ts",
"title": "Cost-Tiered Pipeline",
"description": "Compare the token and cost profile of an all-flagship pipeline with a tiered model mix.",
"section": "goal",
"goal": "production-controls",
"capabilities": ["run-tasks", "cost-control", "multi-model"],
"format": "script",
"level": "intermediate"
},
{
"id": "eval-online-sampling",
"path": "patterns/eval-online-sampling.ts",
"title": "Online Evaluation Sampling",
"description": "Sample live runs for asynchronous scoring in a durable FileEvalStore with explicit shutdown.",
"section": "goal",
"goal": "production-controls",
"capabilities": ["evaluation"],
"format": "script",
"level": "advanced"
},
{
"id": "trace-observability",
"path": "integrations/trace-observability.ts",
"title": "Trace Observability",
"description": "Collect structured onTrace events for LLM calls, tools, tasks, and agent runs.",
"section": "goal",
"goal": "production-controls",
"capabilities": ["observability"],
"format": "script",
"level": "intermediate"
},
{
"id": "express-customer-support",
"path": "integrations/express-customer-support",
"title": "Express Customer Support",
"description": "Embed a structured runTasks() support pipeline behind an Express POST /tickets endpoint.",
"section": "goal",
"goal": "connect-your-stack",
"capabilities": ["http-server", "run-tasks", "structured-output"],
"format": "app",
"level": "intermediate",
"featuredOrder": 1,
"entrypoints": ["index.ts"]
},
{
"id": "mcp-github",
"path": "integrations/mcp-github.ts",
"title": "MCP GitHub",
"description": "Connect an MCP server over stdio and expose its tools through the OMA tool registry.",
"section": "goal",
"goal": "connect-your-stack",
"capabilities": ["mcp", "custom-tools"],
"format": "script",
"level": "intermediate",
"featuredOrder": 2
},
{
"id": "with-vercel-ai-sdk",
"path": "integrations/with-vercel-ai-sdk",
"title": "Vercel AI SDK",
"description": "Combine OMA runTeam() orchestration with an AI SDK streaming chat interface in Next.js.",
"section": "goal",
"goal": "connect-your-stack",
"capabilities": ["ai-sdk", "run-team", "streaming", "http-server"],
"format": "app",
"level": "intermediate",
"featuredOrder": 3,
"entrypoints": ["app/api/chat/route.ts"]
},
{
"id": "external-agent-acp",
"path": "integrations/external-agent-acp.ts",
"title": "External Agent over ACP",
"description": "Use an external coding CLI over ACP as a team member in an OMA task DAG.",
"section": "goal",
"goal": "connect-your-stack",
"capabilities": ["external-agents", "acp", "run-tasks"],
"format": "script",
"level": "advanced",
"featuredOrder": 4
},
{
"id": "with-tencentdb-memory",
"path": "integrations/with-tencentdb-memory",
"title": "TencentDB Agent Memory",
"description": "Back an OMA team's shared memory with TencentDB-Agent-Memory through its Hermes Gateway.",
"section": "goal",
"goal": "connect-your-stack",
"capabilities": ["long-term-memory", "shared-memory", "custom-tools", "run-team"],
"format": "multi-file",
"level": "advanced",
"featuredOrder": 5,
"entrypoints": ["team-with-memory.ts"]
},
{
"id": "external-agent-process",
"path": "integrations/external-agent-process.ts",
"title": "External Agent Process",
"description": "Run deterministic local subprocesses as external agents without a model API key.",
"section": "goal",
"goal": "connect-your-stack",
"capabilities": ["external-agents", "process-backend", "run-tasks"],
"format": "script",
"level": "intermediate"
},
{
"id": "mcp-bilig-workpaper",
"path": "integrations/mcp-bilig-workpaper.ts",
"title": "MCP Bilig WorkPaper",
"description": "Use Bilig WorkPaper MCP tools for formula readback, recalculation, and persisted workbook data.",
"section": "goal",
"goal": "connect-your-stack",
"capabilities": ["mcp", "custom-tools"],
"format": "script",
"level": "advanced"
},
{
"id": "mcp-open-design",
"path": "integrations/mcp-open-design.ts",
"title": "MCP Open Design",
"description": "Drive multiple asynchronous Open Design MCP jobs in parallel through an explicit task pipeline.",
"section": "goal",
"goal": "connect-your-stack",
"capabilities": ["mcp", "custom-tools", "run-tasks", "parallel-execution"],
"format": "script",
"level": "advanced"
},
{
"id": "with-engram",
"path": "integrations/with-engram",
"title": "Engram Memory",
"description": "Use Engram for manual agent memory tools or as the shared-memory store behind runTeam().",
"section": "goal",
"goal": "connect-your-stack",
"capabilities": ["long-term-memory", "shared-memory", "custom-tools", "run-team"],
"format": "multi-file",
"level": "advanced",
"entrypoints": ["research-team.ts", "team-research.ts"]
},
{
"id": "azure-openai",
"path": "providers/azure-openai.ts",
"title": "Azure OpenAI",
"description": "Run the standard three-agent team with Azure OpenAI deployments.",
"section": "models-providers",
"capabilities": ["provider-adapter"],
"format": "script",
"level": "beginner"
},
{
"id": "bedrock",
"path": "providers/bedrock.ts",
"title": "AWS Bedrock",
"description": "Run the standard three-agent team through the AWS Bedrock Converse API.",
"section": "models-providers",
"capabilities": ["provider-adapter"],
"format": "script",
"level": "intermediate"
},
{
"id": "copilot",
"path": "providers/copilot.ts",
"title": "GitHub Copilot",
"description": "Run the standard three-agent team through GitHub Copilot's OpenAI-compatible endpoint.",
"section": "models-providers",
"capabilities": ["provider-adapter", "openai-compatible"],
"format": "script",
"level": "beginner"
},
{
"id": "deepseek",
"path": "providers/deepseek.ts",
"title": "DeepSeek",
"description": "Run the standard three-agent team with DeepSeek models.",
"section": "models-providers",
"capabilities": ["provider-adapter"],
"format": "script",
"level": "beginner"
},
{
"id": "doubao",
"path": "providers/doubao.ts",
"title": "Doubao",
"description": "Run the standard three-agent team through ByteDance Volcengine Ark.",
"section": "models-providers",
"capabilities": ["provider-adapter", "openai-compatible"],
"format": "script",
"level": "beginner"
},
{
"id": "gemini",
"path": "providers/gemini.ts",
"title": "Google Gemini",
"description": "Run the standard three-agent team with the native Google Gemini adapter.",
"section": "models-providers",
"capabilities": ["provider-adapter"],
"format": "script",
"level": "beginner"
},
{
"id": "gemma4-local",
"path": "providers/gemma4-local.ts",
"title": "Gemma 4 Local",
"description": "Run both execution modes locally with Gemma 4 through Ollama and no cloud API key.",
"section": "models-providers",
"capabilities": ["provider-adapter", "local-models", "openai-compatible"],
"format": "script",
"level": "intermediate"
},
{
"id": "grok",
"path": "providers/grok.ts",
"title": "Grok",
"description": "Run the standard three-agent team with xAI Grok models.",
"section": "models-providers",
"capabilities": ["provider-adapter"],
"format": "script",
"level": "beginner"
},
{
"id": "groq",
"path": "providers/groq.ts",
"title": "Groq",
"description": "Run the standard three-agent team through Groq's OpenAI-compatible API.",
"section": "models-providers",
"capabilities": ["provider-adapter", "openai-compatible"],
"format": "script",
"level": "beginner"
},
{
"id": "hunyuan",
"path": "providers/hunyuan.ts",
"title": "Tencent Hunyuan",
"description": "Run the standard three-agent team with Tencent Hunyuan through MaaS.",
"section": "models-providers",
"capabilities": ["provider-adapter"],
"format": "script",
"level": "beginner"
},
{
"id": "local-quantized",
"path": "providers/local-quantized.ts",
"title": "Local Quantized Model",
"description": "Tune sampling and tool-call behavior for a quantized local model on vLLM or llama-server.",
"section": "models-providers",
"capabilities": ["provider-adapter", "local-models", "openai-compatible"],
"format": "script",
"level": "advanced"
},
{
"id": "mimo",
"path": "providers/mimo.ts",
"title": "MiMo",
"description": "Run the standard three-agent team with Xiaomi MiMo's API.",
"section": "models-providers",
"capabilities": ["provider-adapter", "openai-compatible"],
"format": "script",
"level": "beginner"
},
{
"id": "minimax",
"path": "providers/minimax.ts",
"title": "MiniMax",
"description": "Run the standard three-agent team with MiniMax models.",
"section": "models-providers",
"capabilities": ["provider-adapter"],
"format": "script",
"level": "beginner"
},
{
"id": "mistral",
"path": "providers/mistral.ts",
"title": "Mistral",
"description": "Run the standard three-agent team through Mistral's OpenAI-compatible API.",
"section": "models-providers",
"capabilities": ["provider-adapter", "openai-compatible"],
"format": "script",
"level": "beginner"
},
{
"id": "moonshot",
"path": "providers/moonshot.ts",
"title": "Moonshot AI",
"description": "Run the standard three-agent team through Moonshot AI's OpenAI-compatible API.",
"section": "models-providers",
"capabilities": ["provider-adapter", "openai-compatible"],
"format": "script",
"level": "beginner"
},
{
"id": "ollama",
"path": "providers/ollama.ts",
"title": "Ollama",
"description": "Mix a local Ollama model with a cloud model in one task pipeline.",
"section": "models-providers",
"capabilities": ["provider-adapter", "local-models", "openai-compatible", "multi-model"],
"format": "script",
"level": "intermediate"
},
{
"id": "openrouter",
"path": "providers/openrouter.ts",
"title": "OpenRouter",
"description": "Run the standard three-agent team through OpenRouter's OpenAI-compatible API.",
"section": "models-providers",
"capabilities": ["provider-adapter", "openai-compatible"],
"format": "script",
"level": "beginner"
},
{
"id": "qiniu",
"path": "providers/qiniu.ts",
"title": "Qiniu",
"description": "Run the standard three-agent team through Qiniu's OpenAI-compatible API.",
"section": "models-providers",
"capabilities": ["provider-adapter", "openai-compatible"],
"format": "script",
"level": "beginner"
},
{
"id": "qwen",
"path": "providers/qwen.ts",
"title": "Qwen",
"description": "Run the standard three-agent team through DashScope's OpenAI-compatible API.",
"section": "models-providers",
"capabilities": ["provider-adapter", "openai-compatible"],
"format": "script",
"level": "beginner"
},
{
"id": "zhipu",
"path": "providers/zhipu.ts",
"title": "Zhipu GLM",
"description": "Run the standard three-agent team through Zhipu's OpenAI-compatible API.",
"section": "models-providers",
"capabilities": ["provider-adapter", "openai-compatible"],
"format": "script",
"level": "beginner"
}
]
}