For AI agents: the complete documentation index is available at https://scriptedalchemy.github.io/agent-bundle/llms.txt, the full documentation bundle is available at https://scriptedalchemy.github.io/agent-bundle/llms-full.txt, and this page is available as Markdown at https://scriptedalchemy.github.io/agent-bundle/reference/api.md.
agent-bundle
  • English

      • Type API

      The symbol-level reference is generated from the source, not written by hand. Browse it at Type API, or reach it from the top navigation.

      What it covers

      Every public entry point is documented from its declarations:

      Entry pointContents
      agent-bundleThe authoring and orchestration surface: defineSkill, canonicalAgentEvents, startDevServer, runEvals, compareEvals, the eval harness factories, and the artifact-manifest helpers.
      agent-bundle/apiThe programmatic compiler: build, validate, inspect, prepack, their option and result types, and the AgentComponentKind / componentKindCapability component-kind helpers.
      agent-bundle/configdefineConfig and the configuration types.
      agent-bundle/testThe route-testing harness, matchers, and contract matrices.
      agent-bundle/test/browserThe MCP App bridge harness for browser-rendered views.
      agent-bundle/evalEval suite definitions, assertions, and run comparison.
      agent-bundle/rstestThe Rstest configuration helper.
      agent-bundle/metaThe build-time project identity constant, replaced by the compiler in every compiled surface.
      agent-bundle/mcp-appsThe MCP App resource registry contract, replaced by the compiler in local MCP servers.
      agent-bundle/cli-entryThe routed-CLI shell every generated CLI executable is built on.
      agent-bundle/mcp-entryThe stdio MCP entry shell every generated MCP server is wrapped in.
      agent-bundle/routesThe route-module authoring types (AgentEventRouteProps, ToolRouteProps, CliRouteProps, the config shapes) and appResourceUri, the static reference to a sibling MCP App the compiler resolves to its resourceUri.

      Because it is generated, it always matches the shipped types: signatures, unions, defaults, and the error classes each surface can throw. When this Reference section and the generated pages disagree, the generated pages are correct.

      Generated pages are language-neutral

      The site mirrors the generated reference under both locales, so /api/ and /zh/api/ resolve for readers of either language. The content is not translated: the symbol documentation is extracted from source comments and stays in the language it was authored in.

      That is deliberate. A translated copy of generated output would drift from the source on the first refactor, and a symbol reference whose types are current but whose prose is stale is worse than one that is honestly monolingual. Hand-written pages — everything in the Guide and the rest of this Reference — are complete translations.

      Where to start

      • Compiling from a script: build and validate in agent-bundle/api.
      • Writing tests: renderRoute, expectDocument, and the matrices in agent-bundle/test, explained in Testing.
      • Writing evals: defineEvalSuite and the assertions in agent-bundle/eval, explained in Evaluations.