Setup Wizard

RetainDB Wizard is the fastest way to get from zero to a working project. It handles authentication, project selection, basic connector setup, and MCP scaffolding so you can prove the integration before you hand-roll your own flow.

When to use RetainDB Wizard

Use Wizard when you want to:

• create or choose a project quickly
• avoid copying credentials around by hand
• test the product before committing to custom setup
• generate MCP config for Claude or other supported clients

If you already know you want raw HTTP or a custom deployment flow, skip to the 5 minute quickstart.

Run it

npx RetainDB-wizard

If you already use Bun:

bunx RetainDB-wizard

What happens during the flow

1. Wizard authenticates you and finds or creates the right project context.
2. It confirms the API key and base URL it should use.
3. It can guide you through adding an initial source.
4. It can generate MCP config for a supported client.
5. It asks you to run a simple verification step so you know the setup works.

What you need before running it

• Node.js or Bun
• network access to your RetainDB deployment
• permission to create or use a project

What success looks like

When Wizard finishes, you should have all of these:

• a working project
• valid credentials
• one confirmed read or write path
• enough config to continue with SDK, API, or MCP setup

If you want MCP output

Wizard is a good first choice if your end goal is MCP. After the main flow, continue with:

• MCP setup and tools
• Claude Desktop setup
• Claude Code setup

Troubleshooting

Wizard cannot authenticate

Check that you can reach the configured RetainDB base URL and that your account can access the target project.

Wizard completes but follow-up requests fail

Use the generated config values directly and verify them with the 5 minute quickstart.

Wizard is convenient, but you need more control

Move to SDK quickstart or the API pages once the first-run flow is working.

Next step

If Wizard got you to a working environment, use SDK quickstart or projects and sources to keep building.