VYG Docs
Connect

Connect from your agent

Sign a new brand up from an AI agent, then reconnect with the API key it returns.

The user-facing version of this guide is vyg.ai/connect. This page has the same setup commands for developers and partners.

There are two MCP endpoints:

EndpointWho it is forAuth
https://api.vyg.app/mcp/startPeople without an account. Serves only the onboarding tools.None
https://api.vyg.app/mcpExisting accounts. Serves the full tool catalog.OAuth sign-in or an API key

1. Connect to the signup endpoint

Add the server as vyg-start in your agent.

Claude Code

claude mcp add --transport http vyg-start https://api.vyg.app/mcp/start

Codex

codex mcp add vyg-start --url https://api.vyg.app/mcp/start

Claude, ChatGPT and Grok

Open the assistant and send this prompt. The assistant reads the guide and follows it:

Help me set up VYG for my company and connect it to this assistant. Read this page first and follow its guide: vyg.ai/connect?agent=claude

Replace claude with chatgpt or grok. In Claude and ChatGPT you can also add https://api.vyg.app/mcp/start as a custom connector in Settings > Connectors.

Any other MCP client

Connect over streamable HTTP to https://api.vyg.app/mcp/start. No headers are needed.

2. Sign up through the agent

Ask the agent to sign you up. It calls, in order:

  1. onboarding_start with your email, company name and website. It returns a resume_token that is valid for 24 hours.
  2. onboarding_set_password.
  3. onboarding_connect_platform, or skip it. For Shopify, open the install_url it shows you.
  4. onboarding_send_verification, then onboarding_verify_code with the 6-digit code from your email.
  5. onboarding_provision_account. It creates the account and returns mcp_api_key.

onboarding_status shows the current step at any time. To attribute a signup, pass agent and source_ref to onboarding_start.

3. Reconnect with the API key

onboarding_provision_account returns the API key once. Save it. Then add https://api.vyg.app/mcp as vyg with the key as a Bearer header, and remove vyg-start.

Claude Code

claude mcp add --transport http vyg https://api.vyg.app/mcp --header "Authorization: Bearer <mcp_api_key>"

Restart the session so the vyg tools load.

Codex

Add an MCP server named vyg with url https://api.vyg.app/mcp and the http header Authorization: Bearer <mcp_api_key> in ~/.codex/config.toml, then restart Codex.

Claude and ChatGPT

In Settings > Connectors, add https://api.vyg.app/mcp as a custom connector and sign in with the account email and password.

Any other MCP client

Connect over streamable HTTP to https://api.vyg.app/mcp and send Authorization: Bearer <mcp_api_key> on every request.

Existing accounts

If you already have an account, skip the signup endpoint. Follow Claude, Claude Code, Cursor or Other clients to connect to https://api.vyg.app/mcp. API keys are covered in API keys.

On this page