TypeScript SDK

Install

Install @ratel-ai/sdk: requirements, prebuilt native targets, optional packages, and the embedding model download.

One package, no service:

npm install @ratel-ai/sdk

The package is ESM (type: module) and needs Node.js 20.6 or newer.

Prebuilt native targets

The SDK bundles Ratel's Rust core as a native module. Prebuilt bindings ship for:

macOS: darwin-arm64, darwin-x64
Linux (glibc): linux-x64-gnu, linux-arm64-gnu
Windows: win32-x64-msvc

On these targets nothing compiles at install time and no Rust toolchain is needed.

What else you might install

MCP ingestion: registerMcpServer works out of the box; the MCP client (@modelcontextprotocol/sdk) ships as a dependency.
Semantic & hybrid retrieval: nothing to install. Opting in downloads the default local embedding model on first use; see The embedding cache and Semantic & hybrid search.

Next steps

Quickstart

Register a tool and let an agent discover it through the capability tools.

Packages

The four npm packages behind the TypeScript surface.

Related projects

The Ratel ecosystem around the Ratel SDK: the core repo, Ratel Local, the benchmark, the skills suite, and Ratel Cloud.

Quickstart

Install @ratel-ai/sdk, create the ratel() core, register your tools and prompt playbooks, and hand any agent loop the three capability tools.

On this page

Prebuilt native targets What else you might install Next steps