GET STARTED

Setup

Turn an existing API into a scoped remote MCP server, end to end from the CLI.

Skip the manual steps — let your coding agent do it

Paste this prompt into Claude, Codex, or any coding agent already sitting in your project. It first asks whether you're connecting an existing API or starting a new project with a hosted database, runs npx uivoid create, and reviews the tools with you before anything is created.

Free to start · no signup required to try it · same prompt as on uivoid.app

Or do it by hand — 1. Sign in

Everything runs through the CLI — there's no dashboard step to do by hand first.

npx uivoid login

Opens the uivoid portal in your browser and returns a revocable personal access token to a local loopback callback. Credentials are stored at ~/.config/uivoid/config.json (mode 0600). Check who you're signed in as any time:

npx uivoid whoami

2. Create your first project

npx uivoid create my-app

The CLI asks for your existing API's base URL, discovers its OpenAPI document at /openapi.json, /api/openapi.json, or /swagger.json (pass --openapi <url> if it lives elsewhere), and walks you through reviewing the discovered operations before anything is created:

✓ Created my-app
✓ Found OpenAPI document at https://api.example.com/openapi.json
✓ Mapped 9 scoped tools
✓ MCP server active

Ready  https://my-app.uivoid.app/mcp
Auth: organization login · 9 tools mapped

Scopes come from the HTTP method — GET → read, POST/PUT/PATCH → write, DELETE → destructive — and destructive tools start unchecked in the review step, so nothing dangerous gets exposed without you explicitly opting in.

3. Connect an agent

The printed URL (https://my-app.uivoid.app/mcp) is a standard remote MCP server. uivoid is model-agnostic — point Claude, an OpenAI client, or any other MCP-capable agent at that URL and it can start calling your scoped tools immediately. No SDK, no generated client.

Where to next

See the CLI reference for every command and flag (the CLI is also on npm), Using the Portalif you'd rather create and manage a project from the dashboard, and Authentication for how the outbound side — uivoid calling your real API — is secured.