Skip to main content
Claude Code runs as a terminal agent that can read your repo, write files, and execute commands. Paste the prompt below to scaffold a Lumx integration into an existing project — or to bootstrap a new one — without ever putting your API key in client code.

Prerequisites

  • A Lumx account with a Sandbox API key
  • Claude Code installed and authenticated
  • A project (or empty directory) where the integration should land

Step 1 — Get your Lumx credentials

From the Lumx Dashboard, open Developers → API Keys and copy a Sandbox key. See Authentication. Keys are only shown once.

Step 2 — Store the key locally

Drop the secrets into the project’s env file. Keep it out of git.
.env.local
.gitignore (append if missing)
If your project doesn’t already have a CLAUDE.md, consider adding one rule:
CLAUDE.md
Claude Code can read every file in the working directory. Make sure .env.local is gitignored before you commit, and never paste your key into the chat.

Step 3 — Hook up the Lumx docs MCP

The Lumx documentation ships as an MCP server so Claude Code can pull endpoint shapes and field definitions on demand — no copying schemas into the prompt. Run:
Add the MCP server
Restart your session. Claude Code will now answer questions like “what fields does POST /transactions/on-ramp accept?” by querying the docs directly, and the agent will reach for the MCP automatically when it needs schema details mid-task.

Step 4 — Paste the prompt

In the Claude Code session, paste the prompt below.
Lumx integration prompt

Step 5 — Verify end to end

Claude Code will write the files, run the project, and (because the prompt asks for it) call each route with curl to confirm the shape. Walk the UI flow once: create a customer, open the verification link, start an on-ramp, and watch the transaction status update.

Example: a server-side Lumx helper

The prompt aims for this shape. Drop it in directly if you’d rather skip the agent for the helper itself.
server/lumx.ts

FAQ

Yes — Lumx ships an MCP server that surfaces every page in this site as a tool. See MCP server for setup. Claude Code will pull endpoint shapes and field definitions on demand.
Reject the change and add .env*.local to .gitignore first. If the file was already committed, rotate the key in the Dashboard and remove the file with git rm --cached .env.local.
Replace LUMX_API_KEY with a Production key and set LUMX_ENV=production. Production access requires a call with the Lumx team — see Environments.
Yes. The prompt asks Claude Code to confirm a stack before scaffolding — just answer with the framework you want (Next.js, FastAPI, Rails, etc.) and it will set up an idiomatic project.

Next steps

  • Create a customer — full reference for the customer payload
  • Webhooks — subscribe to status changes instead of polling
  • MCP server — give Claude Code structured access to the Lumx docs