Skip to main content
Version: Next — Unreleased

Javadoc

The full API reference is published as a separate Javadoc artifact, served alongside these docs at /javadoc/next/. Start at the surfaces overview, which links the three surfaces and explains how they are split.

How the API reference is organised​

The reference is built from source as three stitched surfaces:

  • Core API — the aggregate of the framework's named modules that export public API (core, runtime, bootstrap, llm, config-loader, schema, and more).
  • MCP integration — agentforge4j-mcp.
  • Spring Boot starter — agentforge4j-spring-boot-starter.

The MCP and Spring Boot starter modules are documented separately because they are intentionally classpath-only (no module descriptor), so Javadoc cannot place them in the same modular aggregate. Provider modules that only register a service-provider implementation export no public API and are intentionally absent — there is nothing public to document.

Linking to a type​

Throughout the docs, an API type links straight into the reference — for example AgentForge4jBootstrap is the framework-agnostic entry point, and LlmClient is the provider client interface.