Ratel Docs
Reference

Package list

Package map for the Ratel SDK and Ratel Local, with raw API references generated from source doc comments.

The Ratel SDK ships as eight packages across three languages: two SDKs, two framework adapters, a Rust core, and a telemetry stack. Ratel Local ships separately as @ratel-ai/ratel-local.

The Core package pages below expose every exported symbol with its signature and doc comment, generated straight from ratel-ai/ratel, plus each package's changelog, verbatim. For the guided, cross-language SDK surface, start at SDKs instead.

PackageLanguageWhat it is
ratel-ai-coreRustThe Rust core both SDKs bundle: registries, retrieval, trace stream
ratel-ai-telemetry (crate)RustThe Rust vocabulary for the ratel.* semantic conventions
@ratel-ai/sdkTypeScriptThe TypeScript SDK: the ratel() core, catalogs, capability tools, MCP ingestion
@ratel-ai/vercel-ai-sdkTypeScriptVercel AI SDK adapter: ratel().adaptTo(aiSdk()) — AI SDK-native tools and per-turn recall (ai@57), plus the ./otel telemetry integration (RatelOtelIntegration, ai@7)
@ratel-ai/mastraTypeScriptMastra adapter: ratel().adaptTo(mastra())createTool tools and per-turn recall via recallProcessor() (@mastra/core 1.11+)
@ratel-ai/telemetryTypeScriptOTel-free ratel.* semantic-convention vocabulary
@ratel-ai/ratel-localTypeScriptThe package that powers Ratel Local: MCP serving, CLI configuration, and library embedding
ratel-aiPythonThe Python SDK: same surface as TypeScript, PyO3-bundled core
ratel-ai-telemetryPythonThe ratel.* overlay on OpenTelemetry gen_ai spans

Every generated Core package page carries its source commit. The generator lives in the docs repo (apps/docs/scripts/sync-api-reference.mjs) and pulls from doc comments (rustdoc, TSDoc, and Python docstrings), which are lint-enforced at the source, so these pages track the shipped API rather than a hand-maintained copy. The Ratel Local package reference points to its separately maintained source and product documentation.