@ratel-ai/ratel-local
Package reference for the MCP server, CLI, and library that power Ratel Local.
@ratel-ai/ratel-local is the TypeScript package behind Ratel Local. It
connects upstream MCP servers to one searchable catalog and exposes Ratel's capability
tools to Claude Code, Codex, Cursor, and other MCP clients.
Start with Ratel Local
Install the latest stable release and run the setup wizard for Claude Code or Codex. Follow the Ratel Local quickstart to prepare the daemon, connect agents, review an existing MCP setup when needed, and verify capability search. Cursor uses manual MCP configuration.
Entry points
| Entry point | Purpose |
|---|---|
ratel-local | Run setup; manage the daemon, upstreams, retrieval, skills, and local UI |
createMcpServer | Expose a ToolCatalog as an MCP server from your own process |
buildGatewayFromConfig | Connect configured upstreams and build the catalog used by the server |
Install with npm install @ratel-ai/ratel-local, or run its CLI with
npx -y @ratel-ai/ratel-local.
Operational guides
| Task | Guide |
|---|---|
| install the daemon and connect supported agents | Quickstart |
| manage the persistent service and project gateways | Daemon |
| add, inspect, edit, or remove upstreams | MCP servers |
| configure BM25, semantic, or hybrid search | Retrieval |
| migrate native Claude Code or Codex entries | Import or link |
| authorize HTTP or SSE upstreams | OAuth upstreams |
| manage skills and the Claude Code preload hook | Managing skills |
| manage configuration from the browser | Browser UI |
| inspect local events and estimated savings | Statusline & local telemetry |
| opt into the experimental Cloud relay | Experimental Cloud telemetry |
| create the gateway from Node code | Embed as a library |
| diagnose setup and recover config files | Troubleshooting |
The package is published on npm, with source in ratel-ai/ratel-local.