Graphorin

Appearance

Graphorin API reference v0.1.0

Graphorin API reference / @graphorin/tools

@graphorin/tools ​

Typed tool surface for the Graphorin framework.

@graphorin/tools ships the runtime building blocks every other @graphorin/* package above the persistence layer uses to declare, register, and execute tools the model can call:

  • tool({...}) — typed factory for declaring a Zod-validated tool. Inference flows from inputSchema / outputSchema into the execute(input, ctx) callback so authors never repeat the input shape.
  • createToolRegistry(...) — strategy-aware registry that hosts every registered tool. Supports the back-compat assertNoDuplicates() pure-detection signature AND the strategy-aware assertNoDuplicates(strategy, ctx) overload that resolves cross-source collisions through the 'auto-prefix' | 'priority' | 'manual' strategies (with a first-party / trusted-skill > untrusted-skill > MCP precedence ladder).
  • createToolExecutor(...) — runs Tool[] invocations:
    • parallel-by-default dispatch with bounded concurrency (maxParallelTools); executionMode: 'sequential' opts a tool out;
    • approval flow (needsApproval predicate ⟶ blocking gate);
    • per-tool secrets ACL scoping via @graphorin/security/secrets’s withChildToolSecretsContext;
    • sandbox-policy resolution via @graphorin/security/sandbox’s resolveSandbox(...) plus an optional sandboxResolver injection point that the skill loader / agent runtime wires when sandbox-bundled code (skills, MCP-derived handlers) needs out-of-process execution (delegates to Sandbox.run(...));
    • memory-modification guard hook (memoryGuardFactory + memoryRegionReader) — snapshot-before, verify-after, with the mismatch path emitting an audit row and the tool.executor.memory_guard.mismatch.total{toolName,tier} counter increment;
    • hard-kill cancellation with a configurable grace window for tools that ignore ctx.signal (50 ms default; cancellation surfaces ToolError({ kind: 'aborted' }) and setStatus('cancelled') on the span);
    • single-round tool repair via the operator-supplied repair hook;
    • per-execution tool.execute AISpan emitted via the run's tracer with rich attributes (graphorin.tool.name, graphorin.tool.call_id, graphorin.tool.sandbox.kind, graphorin.tool.sandbox.forced, graphorin.tool.sandbox.no_network, graphorin.tool.sandbox.no_filesystem, graphorin.tool.memory_guard.tier, graphorin.tool.sensitivity, graphorin.tool.side_effect_class, graphorin.tool.streaming_hint, graphorin.tool.trust_class, graphorin.tool.duration_ms, graphorin.tool.result.contentpart.kind.<image|audio|file>, graphorin.tool.result.truncation.strategy, graphorin.tool.result.truncation.applied, graphorin.tool.result.max_tokens, graphorin.tool.inbound.sanitization.scan_duration_us, graphorin.tool.inbound.sanitization.policy, graphorin.tool.inbound.sanitization.patterns_hit_count);
    • per-execution audit rows + counter increments keyed under stable prefixes (tool.executor.*, tool.classification.*, tool.collision.*, tool.inbound.sanitization.*, tool.result.*, tool.streaming.*, tool.preferred-model.*, tool.retrieval.*).
  • Default spill writer — when no operator-supplied SpillWriter is configured, the executor writes spill artifacts to <os.tmpdir()>/graphorin-spill/<runId>/<toolCallId>.<ext> with 0600 permissions and tier-aware sensitivity inheritance from Tool.sensitivity. Operators that need a sandbox-aware path ('worker-threads' / 'isolated-vm' / 'docker' tier filesystems) inject their own writer via createToolExecutor({ spill }).
  • Inbound prompt-injection sanitization — five-policy pipeline ('pass-through' | 'detect-and-flag' | 'detect-and-strip' | 'detect-and-wrap' | 'detect-and-strip-and-wrap') keyed off the per-tool trust class. Catalogue lives in @graphorin/observability/redaction/imperative-patterns (sibling to the PII / secrets catalogue used by the outbound exporter validators). Optional failClosed: true opt-in surfaces hits as ToolError({ kind: 'inbound_sanitization_blocked' }) for regulated deployments.
  • Result truncation pipeline — four strategies ('middle' | 'tail' | 'spill-to-file' | 'summarize') honouring per-tool maxResultTokens (default 16384; 0 disables with a one-time WARN). Trust-class auto-defaults: 'tail' for built-in code_execution; 'summarize' for built-in web_search; 'middle' everywhere else. Truncation annotations are bytes-stable AND calibrated to NOT match any imperative-pattern so the downstream sanitization scan is false-positive-free.
  • Streaming-tool execution — opt-in via tool({ streamingHint: true, async execute(_input, ctx) { ctx.streamContent({ kind: 'text', text: 'chunk' }); ctx.reportProgress(1, 3); } }). The executor maintains a per-toolCallId aggregation buffer; the assembled buffer becomes the canonical output when execute returns void. Bounded backpressure queue (streaming.eventQueueDepth, default 256) drops the oldest in-flight event under load while the buffer remains lossless.
  • Side-effect classification — sideEffectClass: 'pure' | 'read-only' | 'side-effecting' | 'external-stateful' REQUIRED on the public surface (with a v0.1 transition mode that emits a one-time WARN per tool name on missing classification and applies the conservative deferred default 'side-effecting'). Companion idempotencyKey?: (input, ctx) => string callback REQUIRED-by-WARN for 'side-effecting' | 'external-stateful' tools — the framework never validates the determinism property; that is the operator's contract.
  • Per-tool model preferences — preferredModel?: ModelHint | ModelSpec with the cost-tier vocabulary 'fast' | 'balanced' | 'smart' exported from @graphorin/core. The agent runtime (Phase 12) reads the per-tool hint at the per-step planner; an explicit ModelSpec always wins over the cost-tier vocabulary.
  • Tool retrieval at scale — defer_loading?: boolean opt-in. The built-in tool_search({ query, k? = 5 }) (re-exported by @graphorin/tools/built-in) is auto-registered by the agent runtime when at least one tool is deferred; backed by the three-tier ranking chain (semantic via the agent's embedder ⟶ BM25 fallback ⟶ regex name-match final fallback).
  • Worked examples — optional examples?: ToolExample[] per tool (bounded [1, 5]; overflow emits a one-time WARN). Each example's input and output is validated against the tool's schemas at registration; programming errors fail-fast.

Stable sub-paths ​

ts
// Builder + tool spec.
import { tool } from '@graphorin/tools/builder';

// Strategy-aware registry.
import { createToolRegistry } from '@graphorin/tools/registry';

// Executor.
import { createToolExecutor } from '@graphorin/tools/executor';

// Streaming surface.
import { createStreamingChannel } from '@graphorin/tools/streaming';

// Inbound sanitization.
import { applyInboundSanitization } from '@graphorin/tools/inbound';

// Result envelope helpers + truncation pipeline.
import { truncateBody, toResultEnvelope } from '@graphorin/tools/result';

// Built-in tools (`tool_search`, ...).
import { createToolSearchTool } from '@graphorin/tools/built-in';

// Audit + counter registry.
import { onToolAudit, snapshotCounters } from '@graphorin/tools/audit';

// Typed errors.
import { DuplicateToolNameError } from '@graphorin/tools/errors';

Hello-world ​

ts
import { tool, createToolRegistry, createToolExecutor } from '@graphorin/tools';
import { z } from 'zod';

const greet = tool({
  name: 'greet',
  description: 'Greet the user by name.',
  inputSchema: z.object({ name: z.string() }),
  outputSchema: z.object({ greeting: z.string() }),
  sideEffectClass: 'pure',
  async execute({ name }) {
    return { greeting: `Hello, ${name}!` };
  },
});

const registry = createToolRegistry();
registry.register(greet);

const executor = createToolExecutor({ registry });
const completed = await executor.executeBatch({
  calls: [{ toolCallId: '1', toolName: 'greet', args: { name: 'world' } }],
  runContext, // supplied by your agent runtime
  stepNumber: 1,
});

Dependencies ​

  • zod — required peer dependency. Used for input / output / example validation. v3 and v4 are both supported.
  • @graphorin/core — typed contracts (Tool, ToolExecutionContext, ResolvedTool, ToolExample, ContentChunk, SideEffectClass, InboundSanitizationPolicy, TruncationStrategy, ToolTrustClass, the ToolExecuteProgressEvent / ToolExecutePartialEvent agent-event variants, …).
  • @graphorin/security — sandbox policy resolver (resolveSandbox), per-tool secrets ACL plumbing (withChildToolSecretsContext, enforceSecretAcl).
  • @graphorin/observability — imperative-pattern catalogue (@graphorin/observability/redaction/imperative-patterns).

License ​

MIT. Copyright © 2026 Oleksiy Stepurenko.

Project Graphorin · v0.1.0 · MIT License · © 2026 Oleksiy Stepurenko · https://github.com/o-stepper/graphorin

Modules ​

ModuleDescription
@graphorin/tools — typed tool surface for the Graphorin framework.
auditAudit-event emitter + counter registry for @graphorin/tools.
builderTool builder surface for @graphorin/tools.
built-inBuilt-in tools shipped with @graphorin/tools.
errorsTyped error classes for @graphorin/tools.
executorTool executor surface for @graphorin/tools.
inboundInbound prompt-injection sanitization surface for @graphorin/tools.
registryStrategy-aware tool registry surface for @graphorin/tools.
resultTool result envelope helpers for @graphorin/tools — token counting, truncation pipeline (`'middle'
streamingStreaming-tool execution surface for @graphorin/tools.