co-mono/packages/coding-agent/examples/sdk
Mario Zechner 568150f18b Rework custom tools API with CustomToolContext
- CustomAgentTool renamed to CustomTool
- ToolAPI renamed to CustomToolAPI
- ToolContext renamed to CustomToolContext
- ToolSessionEvent renamed to CustomToolSessionEvent
- Added CustomToolContext parameter to execute() and onSession()
- CustomToolFactory now returns CustomTool<any, any> for type compatibility
- dispose() replaced with onSession({ reason: 'shutdown' })
- Added wrapCustomTool() to convert CustomTool to AgentTool
- Session exposes setToolUIContext() instead of leaking internals
- Fix ToolExecutionComponent to sync with toolOutputExpanded state
- Update all custom tool examples for new API
2025-12-31 12:05:24 +01:00
..
01-minimal.ts Add SDK usage examples 2025-12-22 03:14:30 +01:00
02-custom-model.ts Refactor OAuth/API key handling: AuthStorage and ModelRegistry 2025-12-25 03:48:36 +01:00
03-custom-prompt.ts Add SDK usage examples 2025-12-22 03:14:30 +01:00
04-skills.ts WIP: Remove global state from pi-ai OAuth/API key handling 2025-12-25 01:01:03 +01:00
05-tools.ts Rework custom tools API with CustomToolContext 2025-12-31 12:05:24 +01:00
06-hooks.ts WIP: Remove global state from pi-ai OAuth/API key handling 2025-12-25 01:01:03 +01:00
07-context-files.ts WIP: Remove global state from pi-ai OAuth/API key handling 2025-12-25 01:01:03 +01:00
08-slash-commands.ts WIP: Remove global state from pi-ai OAuth/API key handling 2025-12-25 01:01:03 +01:00
09-api-keys-and-oauth.ts Refactor OAuth/API key handling: AuthStorage and ModelRegistry 2025-12-25 03:48:36 +01:00
10-settings.ts WIP: Remove global state from pi-ai OAuth/API key handling 2025-12-25 01:01:03 +01:00
11-sessions.ts feat(coding-agent): Add --session-dir flag for custom session directory 2025-12-25 20:27:41 +01:00
12-full-control.ts Rework custom tools API with CustomToolContext 2025-12-31 12:05:24 +01:00
README.md Refactor OAuth/API key handling: AuthStorage and ModelRegistry 2025-12-25 03:48:36 +01:00

SDK Examples

Programmatic usage of pi-coding-agent via createAgentSession().

Examples

File Description
01-minimal.ts Simplest usage with all defaults
02-custom-model.ts Select model and thinking level
03-custom-prompt.ts Replace or modify system prompt
04-skills.ts Discover, filter, or replace skills
05-tools.ts Built-in tools, custom tools
06-hooks.ts Logging, blocking, result modification
07-context-files.ts AGENTS.md context files
08-slash-commands.ts File-based slash commands
09-api-keys-and-oauth.ts API key resolution, OAuth config
10-settings.ts Override compaction, retry, terminal settings
11-sessions.ts In-memory, persistent, continue, list sessions
12-full-control.ts Replace everything, no discovery

Running

cd packages/coding-agent
npx tsx examples/sdk/01-minimal.ts

Quick Reference

import { getModel } from "@mariozechner/pi-ai";
import {
  AuthStorage,
  createAgentSession,
  discoverAuthStorage,
  discoverModels,
  discoverSkills,
  discoverHooks,
  discoverCustomTools,
  discoverContextFiles,
  discoverSlashCommands,
  loadSettings,
  buildSystemPrompt,
  ModelRegistry,
  SessionManager,
  codingTools,
  readOnlyTools,
  readTool, bashTool, editTool, writeTool,
} from "@mariozechner/pi-coding-agent";

// Auth and models setup
const authStorage = discoverAuthStorage();
const modelRegistry = discoverModels(authStorage);

// Minimal
const { session } = await createAgentSession({ authStorage, modelRegistry });

// Custom model
const model = getModel("anthropic", "claude-opus-4-5");
const { session } = await createAgentSession({ model, thinkingLevel: "high", authStorage, modelRegistry });

// Modify prompt
const { session } = await createAgentSession({
  systemPrompt: (defaultPrompt) => defaultPrompt + "\n\nBe concise.",
  authStorage,
  modelRegistry,
});

// Read-only
const { session } = await createAgentSession({ tools: readOnlyTools, authStorage, modelRegistry });

// In-memory
const { session } = await createAgentSession({
  sessionManager: SessionManager.inMemory(),
  authStorage,
  modelRegistry,
});

// Full control
const customAuth = new AuthStorage("/my/app/auth.json");
customAuth.setRuntimeApiKey("anthropic", process.env.MY_KEY!);
const customRegistry = new ModelRegistry(customAuth);

const { session } = await createAgentSession({
  model,
  authStorage: customAuth,
  modelRegistry: customRegistry,
  systemPrompt: "You are helpful.",
  tools: [readTool, bashTool],
  customTools: [{ tool: myTool }],
  hooks: [{ factory: myHook }],
  skills: [],
  contextFiles: [],
  slashCommands: [],
  sessionManager: SessionManager.inMemory(),
});

// Run prompts
session.subscribe((event) => {
  if (event.type === "message_update" && event.assistantMessageEvent.type === "text_delta") {
    process.stdout.write(event.assistantMessageEvent.delta);
  }
});
await session.prompt("Hello");

Options

Option Default Description
authStorage discoverAuthStorage() Credential storage
modelRegistry discoverModels(authStorage) Model registry
cwd process.cwd() Working directory
agentDir ~/.pi/agent Config directory
model From settings/first available Model to use
thinkingLevel From settings/"off" off, low, medium, high
systemPrompt Discovered String or (default) => modified
tools codingTools Built-in tools
customTools Discovered Replaces discovery
additionalCustomToolPaths [] Merge with discovery
hooks Discovered Replaces discovery
additionalHookPaths [] Merge with discovery
skills Discovered Skills for prompt
contextFiles Discovered AGENTS.md files
slashCommands Discovered File commands
sessionManager SessionManager.create(cwd) Persistence
settingsManager From agentDir Settings overrides

Events

session.subscribe((event) => {
  switch (event.type) {
    case "message_update":
      if (event.assistantMessageEvent.type === "text_delta") {
        process.stdout.write(event.assistantMessageEvent.delta);
      }
      break;
    case "tool_execution_start":
      console.log(`Tool: ${event.toolName}`);
      break;
    case "tool_execution_end":
      console.log(`Result: ${event.result}`);
      break;
    case "agent_end":
      console.log("Done");
      break;
  }
});