Keyboard shortcuts

Press or to navigate between chapters

Press S or / to search in the book

Press ? to show this help

Press Esc to hide this help

Getting Started

This section is for the first working run of the gateway: start the local dependencies, launch the Rust dataplane, seed runtime config, and send real MCP traffic through it.

🚀 Goal: get from a clean checkout to one client-facing MCP endpoint at /contextforge-rs/servers/{virtual_host_id}/mcp.

PageWhat it covers
🚀 Run the Gateway LocallyDocker services, local bootstrap helpers, user config, MCP session setup, and smoke tests.
⚙️ Configuration ReferenceListener settings, Redis wiring, JWT verification, upstream transport, telemetry, logging, and runtime knobs.

What “started” means

A useful local gateway run has these pieces:

PieceWhy it matters
RedisHolds runtime UserConfig keyed by JWT subject.
Backend MCP serversProvide the tools, resources, and prompts the gateway merges.
Gateway listenerAccepts downstream streamable HTTP MCP traffic.
JWT verification key or secretLets the gateway authenticate downstream requests.
User configMaps the caller’s JWT subject to virtual hosts and backend MCP URLs.
MCP sessionBinds downstream session state to backend MCP client sessions.

If one of those is missing, the gateway should fail at the boundary that owns that fact: authentication, config lookup, virtual host resolution, session lookup, routing, or upstream transport.