Skip to content
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
2 changes: 1 addition & 1 deletion SDK_DEVELOPMENT.md
Original file line number Diff line number Diff line change
Expand Up @@ -620,7 +620,7 @@ examples/
- **Self-contained**: Every file imports from `../src/sdk`, connects via `OrkesClients.from()`, and is runnable with `npx ts-node examples/<file>.ts`
- **Cleanup**: Examples that create resources clean up after themselves in try/finally blocks
- **Env vars**: All examples read `CONDUCTOR_SERVER_URL` (required) and optionally `CONDUCTOR_AUTH_KEY`/`CONDUCTOR_AUTH_SECRET`
- **Agent examples**: `examples/agents/` uses `AGENTSPAN_SERVER_URL`/`AGENTSPAN_LLM_MODEL` plus a provider API key — see [examples/agents/README.md](examples/agents/README.md)
- **Agent examples**: `examples/agents/` uses `CONDUCTOR_SERVER_URL`/`CONDUCTOR_AGENT_LLM_MODEL` plus a provider API key — see [examples/agents/README.md](examples/agents/README.md)
- **Naming**: Kebab-case file names matching Python SDK's snake_case pattern (e.g., `fork-join.ts` ↔ `fork_join_script.py`)
- **Imports**: Use relative paths from the example file (e.g., `from "../../src/sdk"` for subdirectory examples)

Expand Down
2 changes: 1 addition & 1 deletion e2e/test_suite6_pdf_tools.test.ts
Original file line number Diff line number Diff line change
Expand Up @@ -32,7 +32,7 @@ afterAll(() => runtime.shutdown());

// ── Sample markdown ─────────────────────────────────────────────────────

const SAMPLE_MARKDOWN = `# Agentspan E2E Test Report
const SAMPLE_MARKDOWN = `# Conductor Agent E2E Test Report

## Overview

Expand Down
4 changes: 2 additions & 2 deletions examples/README.md
Original file line number Diff line number Diff line change
Expand Up @@ -48,8 +48,8 @@ npx ts-node examples/workers-e2e.ts

Agentic examples live in [`agents/`](agents/) and use the durable agents layer
(`@io-orkes/conductor-javascript/agents`). See [agents/README.md](agents/README.md)
for the full catalog and environment setup (`AGENTSPAN_SERVER_URL`,
`AGENTSPAN_LLM_MODEL`, provider API key). Highlights:
for the full catalog and environment setup (`CONDUCTOR_SERVER_URL`,
`CONDUCTOR_AGENT_LLM_MODEL`, provider API key). Highlights:

| File | Description | Run |
|------|-------------|-----|
Expand Down
14 changes: 7 additions & 7 deletions examples/agents/README.md
Original file line number Diff line number Diff line change
@@ -1,6 +1,6 @@
# Examples

Runnable examples demonstrating every feature of the Agentspan TypeScript SDK.
Runnable examples demonstrating every feature of the Conductor TypeScript SDK for Agents.

**200+ runnable examples in total**: the core examples cataloged below, plus
the [quickstart/](quickstart/) guides and framework ports for Google ADK,
Expand Down Expand Up @@ -335,10 +335,10 @@ cd examples/agents/openai && npx tsx 01-basic-agent.ts

## Framework Integrations

| Directory | Framework | Examples |
|-----------|-----------|----------|
| [adk/](adk/) | Google ADK | Agents, tools, streaming, planners, security |
| [langgraph/](langgraph/) | LangGraph | State graphs, react agents, memory, RAG |
| Directory | Framework | Examples |
|-----------|-------------------|----------|
| [adk/](adk/) | Google ADK | Agents, tools, streaming, planners, security |
| [langgraph/](langgraph/) | LangGraph | State graphs, react agents, memory, RAG |
| [openai/](openai/) | OpenAI Agents SDK | Agents, tools, handoffs, guardrails |
| [vercel-ai/](vercel-ai/) | Vercel AI SDK | Agents, tools, streaming, HITL |
| [quickstart/](quickstart/) | Agentspan Quickstart | Minimal getting-started guides |
| [vercel-ai/](vercel-ai/) | Vercel AI SDK | Agents, tools, streaming, HITL |
| [quickstart/](quickstart/) | Agents Quickstart | Minimal getting-started guides |
4 changes: 2 additions & 2 deletions examples/agents/adk/README.md
Original file line number Diff line number Diff line change
@@ -1,11 +1,11 @@
# Google ADK + Agentspan
# Google ADK + Conductor Agent

The `LlmAgent` and `FunctionTool` formats are natively recognized. Replace the ADK runner with `runtime.run()` — agent and tools stay identical.

## Before / After

<table>
<tr><th>Before (vanilla Google ADK)</th><th>After (Agentspan)</th></tr>
<tr><th>Before (vanilla Google ADK)</th><th>After (Conductor Agent)</th></tr>
<tr><td>

```typescript
Expand Down
2 changes: 1 addition & 1 deletion examples/agents/langgraph/34-rag-pipeline.ts
Original file line number Diff line number Diff line change
Expand Up @@ -44,7 +44,7 @@ const DOCUMENTS: Document[] = [
},
{
pageContent:
'Agentspan provides a runtime for deploying LangGraph and LangChain agents at scale. ' +
'Conductor provides a runtime for deploying LangGraph and LangChain agents at scale. ' +
'It uses Conductor as an orchestration engine and exposes agents as Conductor tasks. ' +
'The AgentRuntime class handles worker registration and lifecycle management.',
metadata: { source: 'agentspan_docs', topic: 'agentspan' },
Expand Down
2 changes: 1 addition & 1 deletion examples/agents/langgraph/41-react-agent-basic.ts
Original file line number Diff line number Diff line change
Expand Up @@ -78,7 +78,7 @@ const graph = createReactAgent({ llm, tools, name: "math_and_text_agent" });
const PROMPT =
'What is sqrt(256) + 2**10? ' +
"Also count the words in 'the quick brown fox jumps over the lazy dog'. " +
"And what is 'Agentspan' reversed?";
"And what is 'Conductor' reversed?";

// ---------------------------------------------------------------------------
// Run on agentspan
Expand Down
2 changes: 1 addition & 1 deletion examples/agents/langgraph/46-crash-and-resume.ts
Original file line number Diff line number Diff line change
Expand Up @@ -176,7 +176,7 @@ async function main() {

const uiLink = `${UI_BASE}/execution/${savedExecutionId}`;
console.log('-'.repeat(60));
console.log('Open the Agentspan UI to see the execution in RUNNING state:');
console.log('Open the Conductor UI to see the execution in RUNNING state:');
console.log(` ${uiLink}`);
console.log();
console.log('The workflow is alive on the server but stalled — no workers are');
Expand Down
4 changes: 2 additions & 2 deletions examples/agents/langgraph/README.md
Original file line number Diff line number Diff line change
@@ -1,11 +1,11 @@
# LangGraph + Agentspan
# LangGraph + Conductor Agent

Keep your existing LangGraph code. Add agentspan metadata and run with `runtime.run()`.

## createReactAgent

<table>
<tr><th>Before (vanilla LangGraph)</th><th>After (Agentspan)</th></tr>
<tr><th>Before (vanilla LangGraph)</th><th>After (Conductor Agent)</th></tr>
<tr><td>

```typescript
Expand Down
4 changes: 2 additions & 2 deletions examples/agents/openai/README.md
Original file line number Diff line number Diff line change
@@ -1,11 +1,11 @@
# OpenAI Agents SDK + Agentspan
# OpenAI Agents SDK + Conductor Agent

The OpenAI Agent format is natively recognized. Swap `run()` for `runtime.run()` — agent and tools stay identical.

## Before / After

<table>
<tr><th>Before (vanilla OpenAI Agents)</th><th>After (Agentspan)</th></tr>
<tr><th>Before (vanilla OpenAI Agents)</th><th>After (Conductor Agent)</th></tr>
<tr><td>

```typescript
Expand Down
14 changes: 7 additions & 7 deletions examples/agents/vercel-ai/README.md
Original file line number Diff line number Diff line change
@@ -1,4 +1,4 @@
# Vercel AI SDK + Agentspan
# Vercel AI SDK + Conductor Agent

Two ways to integrate — pick what fits your stage.

Expand All @@ -7,7 +7,7 @@ Two ways to integrate — pick what fits your stage.
Swap one import. Your `generateText()` code stays identical.

<table>
<tr><th>Before (vanilla Vercel AI)</th><th>After (Agentspan)</th></tr>
<tr><th>Before (vanilla Vercel AI)</th><th>After (Conductor Agent)</th></tr>
<tr><td>

```typescript
Expand Down Expand Up @@ -72,7 +72,7 @@ Everything else — tools, model, prompt, result shape — is unchanged. Under t
When you need features that `generateText()` can't express — termination conditions, guardrails, multi-agent handoff, human-in-the-loop — use the Agent API directly.

<table>
<tr><th>Before (vanilla Vercel AI)</th><th>After (Agentspan Agent API)</th></tr>
<tr><th>Before (vanilla Vercel AI)</th><th>After (Conductor Agent API)</th></tr>
<tr><td>

```typescript
Expand Down Expand Up @@ -152,10 +152,10 @@ await runtime.shutdown();

## Examples

| File | Description |
|------|-------------|
| `01-basic-agent.ts` | Simple agent with one AI SDK tool |
| `02-tools-compat.ts` | Mix of Agentspan native and AI SDK tools |
| File | Description |
|------|------------------------------------------------------------------------------|
| `01-basic-agent.ts` | Simple agent with one AI SDK tool |
| `02-tools-compat.ts` | Mix of Conductor native and AI SDK tools |
| `03-streaming.ts` | Default `runtime.run()` flow with a commented `runtime.stream()` alternative |
| `04-structured-output.ts` | Zod schema for typed output |
| `05-multi-step.ts` | Multiple tools, multi-turn conversation |
Expand Down
Loading