mcpField
V
vercel

vercel

github.com/openhandsCloud & DevOps17570 installsUpdated 1d ago
Repository

About vercel

A Vercel deployment guide skill covering protection bypass for automated access, environment variables, and common CLI commands. It explains options for handling protected preview deployments.

Key features

  1. 01Identify protected preview deployments
  2. 02Configure automation bypass secrets
  3. 03Pass bypass secrets in headers or URLs
  4. 04Set environment variables
  5. 05Use common Vercel CLI commands

Use cases

  1. 01Accessing protected preview deployments for testing
  2. 02Configuring environment variables in Vercel
  3. 03Deploying preview or production builds

Install

Copy the command and run it in a terminal.

$npx skills add https://github.com/openhands/extensions --skill vercel

After installing, type/vercelin Claude Code to confirm it loaded.

Bundled files.plugin/plugin.jsonREADME.md

Details

From the project README

Vercel Deployment Guide

Deployment Protection and Agent Access

Vercel deployments may have Deployment Protection enabled, which requires authentication to access preview deployments. This can block automated testing and agent access to preview URLs.

Identifying Protected Deployments

If you encounter a login page or authentication requirement when accessing a Vercel preview URL, the deployment has protection enabled. Signs include:

  • Redirect to vercel.com/login or SSO login page
  • 401/403 errors when accessing the deployment
  • Preview URLs that require Vercel team membership
Enabling Agent Access with Protection Bypass

To allow agents and automated systems to access protected deployments, users need to set up Protection Bypass for Automation:

  1. Navigate to Project Settings

    • Go to the Vercel Dashboard
    • Select the project
    • Click on Settings → Deployment Protection
  2. Generate a Protection Bypass Secret

    • Under "Protection Bypass for Automation", click Generate Secret
    • Copy the generated secret securely
  3. Using the Bypass Secret

    The secret can be used in two ways:

    As a Header:

    curl -H "x-vercel-protection-bypass: <secret>" https://your-preview-url.vercel.app
    

    PowerShell equivalent:

    Invoke-WebRequest -Headers @{ "x-vercel-protection-bypass" = "<secret>" } -Uri https://your-preview-url.vercel.app
    

    As a Query Parameter:

    https://your-preview-url.vercel.app?x-vercel-protection-bypass=<secret>
    
  4. For Browser-Based Testing

    • Append ?x-vercel-protection-bypass=<secret> to the preview URL
    • The secret will be stored in a cookie for subsequent requests
Alternative: Disable Protection for Previews

If protection bypass is not suitable, users can disable protection for preview deployments:

  1. Go to Settings → Deployment Protection
  2. Set "Vercel Authentication" to Only Production Deployments or Disabled
If you cannot access a Vercel preview deployment due to authentication requirements, inform the user that they need to either: 1. Set up a Protection Bypass secret and provide it to you, OR 2. Disable Deployment Protection for preview deployments in their Vercel project settings

Do NOT repeatedly attempt to access protected URLs without the bypass secret.

Environment Variables

Set environment variables in Vercel Dashboard under Settings → Environment Variables, or use the Vercel CLI:

vercel env add MY_SECRET

Access in your application:

const secret = process.env.MY_SECRET;

Vercel CLI Commands

Common Vercel CLI commands:

# Login to Vercel
vercel login

# Deploy to preview
vercel

# Deploy to production
vercel --prod

# List deployments
vercel ls

# View deployment logs
vercel logs <deployment-url>

# Pull environment variables locally
vercel env pull

Comments

Markdown supported