Custom Tools Examples

Example custom tools for omp-coding-agent.

Examples

Each example uses the subdirectory/index.ts structure required for tool discovery.

hello/

Minimal example showing the basic structure of a custom tool.

todo/

Full-featured example demonstrating:

onSession for state reconstruction from session history
Custom renderCall and renderResult
Proper branching support via details storage
State management without external files

Usage

# Test directly (can point to any .ts file)
omp --tool examples/custom-tools/todo/index.ts

# Or copy entire folder to tools directory for persistent use
cp -r todo ~/.omp/agent/tools/

Then in omp:

> add a todo "test custom tools"
> list todos
> toggle todo #1
> clear todos

Writing Custom Tools

See docs/custom-tools.md for full documentation.

Key Points

Factory pattern:

import { Text } from "@oh-my-pi/pi-tui";
import type { CustomToolFactory } from "@oh-my-pi/pi-coding-agent";

const factory: CustomToolFactory = (pi) => ({
	name: "my_tool",
	label: "My Tool",
	description: "Tool description for LLM",
	parameters: pi.zod.object({
		action: pi.zod.enum(["list", "add"]),
	}),

	// Called on session start/switch/branch/clear
	onSession(event) {
		// Reconstruct state from event.entries
	},

	async execute(toolCallId, params) {
		return {
			content: [{ type: "text", text: "Result" }],
			details: {
				/* for rendering and state reconstruction */
			},
		};
	},
});

export default factory;

Custom rendering:

renderCall(args, theme) {
  return new Text(
    theme.fg("toolTitle", theme.bold("my_tool ")) + args.action,
    0, 0  // No padding - Box handles it
  );
},

renderResult(result, { expanded, isPartial }, theme) {
  if (isPartial) {
    return new Text(theme.fg("warning", "Working..."), 0, 0);
  }
  return new Text(theme.fg("success", "✓ Done"), 0, 0);
},

Use z.enum for discriminated string tool args:

const { z } = pi.zod;

parameters: z.object({
	action: z.enum(["list", "add"]),
});