Dashboard

Browse docs

Dashboard

Tap to expand

Contribute

DashboardUpdated 2026-03-18

Dev: Keys, SDK, and MCP

Use the developer section of the dashboard to create API keys safely, then jump into the SDK or MCP setup path that matches how you plan to integrate RetainDB.

The dev section of the dashboard is where programmatic access starts.

It includes three related surfaces:

  • API keys at /dashboard/dev/keys
  • SDK guidance at /dashboard/dev/sdk
  • MCP setup at /dashboard/dev/mcp

API keys

The API keys page is the operational starting point for server-side integrations.

You can:

  • create a new key
  • view existing key prefixes
  • copy a newly created key
  • inspect creation and last-used time
  • delete a key you no longer need

The most important behavior on this page is also the easiest to miss:

the full key is only shown once, immediately after creation.

Warning
If you do not copy a newly created key when the green success panel appears, you should assume you need to create a new one.

SDK

The SDK page is the right destination if you want a typed client and a smoother integration path than raw HTTP.

Use it when:

  • your team is building in TypeScript or JavaScript
  • you want convenience methods around memory, context, or usage
  • you want fewer hand-written request payloads

MCP

The MCP page is for agent and tool integrations, especially Claude-compatible workflows.

The current dashboard MCP page gives you:

  • install instructions
  • config you can copy into your MCP client
  • a list of available tool families
  • example usage patterns

Use this path when the user experience you want is “the agent can call RetainDB tools directly,” not “my backend calls an HTTP API.”

Which path to choose

Choose based on where RetainDB will run:

  • backend service or app server: API key or SDK
  • TypeScript application that wants ergonomics: SDK
  • agent tooling or Claude workflow: MCP

If you are unsure, the SDK is usually the best default for app code and MCP is the best default for agent tooling.

Common mistakes

Using an API key in the browser

Keep API keys server-side. Browser and dashboard flows should use the platform’s user auth model, not your raw secret.

Starting with MCP when you really need backend control

MCP is great for agent workflows, but it is not a replacement for a normal application backend.

Treating key management as a one-time task

Use the page to review last-used times and remove keys that are no longer needed.

Next step

If you need the auth model before you create or use a key, read auth caller model. If you already have a key and want the first programmatic request, go to 5-minute quickstart.

Was this page helpful?

Your feedback helps us prioritize docs improvements weekly.