API reference

Generate the full TypeDoc reference:

bash
npm run docs:typedoc

This runs typedoc --plugin typedoc-plugin-markdown against packages/agent/src/index.ts and writes markdown into docs/reference/api/. The output mirrors the export shape of @fuze-ai/agent; the canonical listing of public symbols is in the package's src/index.ts and the matching .d.ts.

Public surface (high-level)

Top-level factories and runners:

  • defineTool (.public, .personal, .specialCategory, .confidential)
  • defineAgent
  • defineAgentRole — capability envelope for sub-agent dispatch
  • fromMarkdown (+ fromMarkdown.dir) — co-locate instructions/context with code, hashed at module load
  • runAgent
  • resumeRun (and ModelDriftAtResumeError)
  • verifyChain
  • Ok, Err, Suspend
  • inMemorySecrets
  • makeTenantId, makePrincipalId
  • StaticPolicyEngine

Planning + dispatch + oversight:

  • PlanState, buildPlanTools, PLAN_TOOL_NAMES
  • synthesizeDispatchTool, synthesizeDispatchTools, buildDispatchTools, dispatchManifestHash
  • requestOversight, resolveOversight, InMemoryDurableAdapter
  • Helpers: NEVER_RETRY_CATEGORIES, isRetriableCategory, planStepStatusForFailure

Types:

  • FuzeTool, FuzeAgent, FuzeModel, ModelStep, Ctx
  • ThreatBoundary, Retention, Result
  • Art9Basis, LawfulBasis, AnnexIIIDomain
  • EvidenceRecord
  • AgentRoleDefinition, DefineAgentRoleInput, RetryPolicy, OutputViews
  • DispatchResult<T>, AgentRunFailure, AgentErrorCategory, FailureAttribution
  • PlanStep, PlanStepStatus, PlanStepLifecycle, PlanVersion, PlanEvent, PlanCommitInput, PlanStepUpdateInput, PlanReviseInput, LinkageSource, PlanRequirement, PlanningConfig
  • LedgerEntry and variants (ToolCallLedgerEntry, ModelCallLedgerEntry, HumanInputLedgerEntry, Dispatch{Committed,Completed}LedgerEntry, Oversight{Suspend,Resume}LedgerEntry, ExpectedDeterminism)
  • ReplayMode, ReplayResult, ReplayInput, DeterminismVerdict, ToolCallDrift, ModelCallDrift, PlanDrift, OutputDrift
  • DurableExecutionAdapter, OversightRequest, OversightDecision, OversightDecisionKind, OversightReason, ReviewerSignature

Sibling packages:

  • @fuze-ai/agent-policy-cerbos, production policy engine
  • @fuze-ai/agent-mcp, MCP host with admission policy
  • @fuze-ai/agent-mcp-server, expose Fuze tools as MCP server
  • @fuze-ai/agent-sandbox-justbash, local sandbox adapter
  • @fuze-ai/agent-sandbox-e2b, managed sandbox adapter
  • @fuze-ai/agent-tools, first-party tools (bash, fetch, read/write file)
  • @fuze-ai/agent-signing, Ed25519 signer interface + LocalKeySigner
  • @fuze-ai/agent-signing-kms, KMS-backed signer
  • @fuze-ai/agent-suspend-store, SQLite-backed suspend store
  • @fuze-ai/agent-transparency, transparency log anchor + verify
  • @fuze-ai/agent-providers, Mistral, Aleph Alpha, OpenAI EU
  • @fuze-ai/agent-guardrails, input/toolResult/output guardrail set
  • @fuze-ai/agent-redaction, pre-export secret redactor
  • @fuze-ai/agent-eval, eval harness
  • @fuze-ai/agent-cli, CLI for query/replay/verify/export
  • @fuze-ai/agent-api-server, HTTP server for hosted ingest
  • @fuze-ai/agent-annex-iv, Annex IV technical-file generator
  • @fuze-ai/agent-compliance, compliance helpers
  • @fuze-ai/agent-memory, long-term agent memory
  • @fuze-ai/agent-durable, durable execution wrappers
  • @fuze-ai/agent-legal-templates, DPA, processor agreements
  • @fuze-ai/agent-sovereign-terraform, Terraform modules