PreviewShip MCP Server
blockdancez/PreviewShip
Deploy frontend direto do seu agente de IA com um comando
Ver no GitHubServidor MCP que integra PreviewShip nativamente em agentes de IA como Claude. Permite fazer deploy de previews frontend (HTML, Markdown, builds estáticos) diretamente do chat, sem deixar o ambiente de trabalho com IA. Gera URLs compartilháveis em segundos via integração com Vercel.
Instalação
npx convez-ai blockdancez/PreviewShip1 comando no terminal: detecta o formato do repositório (marketplace ou plugin avulso) e instala via Claude Code. Requer Node 18+ e o Claude Code instalado.
Métricas
Casos de uso
- Compartilhar artefatos HTML gerados por Claude/IA como URLs públicas
- Fazer deploy automático de relatórios e páginas estáticas durante fluxos de desenvolvimento com IA
- Publicar previews de componentes e prototipagem gerados por agents de coding
Veredito

Ferramenta prática que fecha uma lacuna real: levar outputs web gerados por IA direto para URL compartilhável sem sair do chat. Implementação sólida com suporte a múltiplos formatos (HTML, Markdown, static builds). Particularmente útil em workflows de prototipagem rápida com agentes.
README
A tradução para o português deste README ainda está na fila.
PreviewShip
Publish HTML and Markdown online, deploy AI-generated pages, and share frontend previews from your editor, terminal, AI agent, or browser.
PreviewShip is a frontend preview deployment, HTML publishing, and Markdown publishing platform for developers and AI-assisted workflows. Upload an HTML or Markdown file to a website, paste generated HTML, host a single file online, or deploy a static build folder and get a shareable preview URL in seconds — no Git, no CI/CD, no complex configuration.
Open Source Packages
PreviewShip provides four open-source client packages:
| Package | npm | Description |
|---|---|---|
| CLI | previewship | Deploy from the terminal with one command |
| MCP Server | previewship-mcp | Native tool integration for AI coding agents |
| VS Code Extension | Marketplace | One-click deploy workspace or active HTML/Markdown file from your editor |
| Agent Skills | GitHub / npx skills | Installable skills for Codex workflows, including high-fidelity chat sharing |
Deployment Methods
| Method | Command / Action | Best For |
|---|---|---|
| CLI | npx previewship deploy ./dist, ./report.html, or ./README.md | Terminal, scripts, CI/CD, generated HTML/Markdown |
| MCP Server | Say "deploy to PreviewShip" in AI chat | Claude Code, Cursor, Windsurf |
| VS Code / Cursor Extension | Command Palette → PreviewShip: Deploy Workspace, HTML, or Markdown File | Editor-first workflow, active HTML/Markdown files |
| Agent Skill | $share-codex-chat 分享当前 Codex 对话 | Publish a Codex conversation as a shareable high-fidelity chat page |
| Web Console | Upload zip/html/markdown or paste HTML at previewship.com | Zero-tool deployment |
HTML Publishing Workflows
- Upload HTML file to website
- HTML file hosting
- Host HTML file online
- Publish HTML file to web
- HTML deployer
- Paste HTML and get a URL
- Turn ChatGPT HTML into a website
- Publish a Claude HTML artifact
- Share a Codex chat transcript as a public PreviewShip URL with the
share-codex-chatskill
CLI
One-command deploy from any terminal. Supports JSON output for AI agents and CI pipelines.
Quick Start
# Set your API Key
npx previewship login --key ps_live_YOUR_KEY
# Deploy a directory
npx previewship deploy ./dist
# Deploy a single HTML file
npx previewship deploy ./report.html
# Deploy a Markdown document
npx previewship deploy ./README.md
For zipped uploads or directory deploys, deploy the static build artifact, not the raw source project. Run your framework build first, then deploy folders such as dist, build, out, public, or a zip containing index.html and its assets. Do not upload a source-code zip with package.json, src/, and node_modules and expect PreviewShip to build it.
Commands
| Command | Description |
|---|---|
previewship login [--key KEY] | Set API Key for authentication |
previewship deploy [path] [-n name] [--json] | Deploy a directory, single HTML file, or Markdown document and get a preview URL |
previewship status <id> [--json] | Check deployment status by ID |
previewship usage [--json] | Show remaining deployment quota |
previewship whoami | Display current configuration |
Options
# Deploy with a custom project name
npx previewship deploy ./dist -n my-project
# JSON output for AI agents and CI
npx previewship deploy ./dist --json
# Custom exclude patterns
npx previewship deploy ./dist --exclude "*.map" --exclude "tests/**"
Project names are display names inside PreviewShip. They can use natural short names; PreviewShip automatically creates a deployment-safe hosting slug.
Environment Variables
| Variable | Description |
|---|---|
PREVIEWSHIP_API_KEY | API Key (overrides saved config) |
PREVIEWSHIP_SERVER_URL | Custom API server URL |
CI | Auto-enables JSON output in CI environments |
NO_COLOR | Disables colored output |
Programmatic Usage
The CLI also exports its core functions for use as a library:
import { deploy, getStatus, getUsage } from 'previewship'
import { ApiClient } from 'previewship'
import { packDirectory, DEFAULT_EXCLUDE_PATTERNS } from 'previewship'
Agent Skills
Installable skills make PreviewShip available as a Codex-native workflow, not just a deployment command. The included share-codex-chat skill turns a Codex conversation into a high-fidelity HTML page and deploys it to PreviewShip, so users can share debugging sessions, implementation reviews, and AI-generated work without taking screenshots.
Install Share Codex Chat
Global install:
npx skills add blockdancez/PreviewShip --skill share-codex-chat -a codex -g --yes
Project-local install, run from the project root:
npx skills add blockdancez/PreviewShip --skill share-codex-chat -a codex --yes
Then use it inside Codex:
$share-codex-chat 分享当前 Codex 对话
The skill preserves visible Codex UI elements such as user bubbles, assistant replies, uploaded image thumbnails, plugin mentions, collapsed processing details, file cards, and edited-file summaries. It filters hidden system/developer context and deploys the generated HTML through the PreviewShip CLI.
MCP Server
Model Context Protocol server that lets AI coding agents deploy previews as a native tool call. Works with Claude Code, Cursor, Windsurf, and any MCP-compatible client.
Setup
Claude Code — add to ~/.claude/settings.json:
{
"mcpServers": {
"previewship": {
"command": "npx",
"args": ["-y", "previewship-mcp"],
"env": {
"PREVIEWSHIP_API_KEY": "ps_live_YOUR_KEY"
}
}
}
}
Cursor — create .cursor/mcp.json in your project root:
{
"mcpServers": {
"previewship": {
"command": "npx",
"args": ["-y", "previewship-mcp"],
"env": {
"PREVIEWSHIP_API_KEY": "ps_live_YOUR_KEY"
}
}
}
}
Windsurf — add to ~/.codeium/windsurf/mcp_config.json:
{
"mcpServers": {
"previewship": {
"command": "npx",
"args": ["-y", "previewship-mcp"],
"env": {
"PREVIEWSHIP_API_KEY": "ps_live_YOUR_KEY"
}
}
}
}
Available Tools
| Tool | Description | Parameters |
|---|---|---|
deploy_preview | Deploy a build-output directory, single HTML file, or Markdown document and get a preview URL | path (optional), projectName (optional), excludePatterns (optional) |
check_deployment | Check deployment status by ID | deploymentId (required) |
show_usage | Show remaining deployment quota | — |
Usage
Once configured, simply ask your AI agent:
"Deploy this project to PreviewShip" "Check the status of my last deployment" "How many deploys do I have left today?"
VS Code / Cursor Extension
One-click deploy from VS Code or Cursor. Deploy a workspace, detected build output, or the active .html/Markdown file. Install from the VS Code Marketplace or Open VSX Registry.
Install
Via Command Palette (Ctrl+P / Cmd+P):
ext install previewship.previewship
Via VSIX (offline install):
code --install-extension previewship-0.1.8.vsix
# Or for Cursor:
cursor --install-extension previewship-0.1.8.vsix
Commands
| Command | Description |
|---|---|
PreviewShip: Set API Key | Store your API Key securely (encrypted via VS Code Secrets API) |
PreviewShip: Deploy Workspace, HTML, or Markdown File | Package, upload, and deploy your project; when an HTML or Markdown file is active, choose file or workspace |
PreviewShip: Deploy Active HTML or Markdown File | Package the active .html or Markdown file as the site entry and deploy it directly |
PreviewShip: Show Usage | Display daily/monthly deployment quota |
Settings
| Setting | Default | Description |
|---|---|---|
previewship.serverUrl | https://api.previewship.com | API server URL |
previewship.excludePatterns | node_modules/**, .git/**, .env*, etc. | File exclude patterns for packaging |
previewship.pollIntervalMs | 3000 | Deployment status polling interval (ms) |
previewship.pollTimeoutMs | 300000 | Polling timeout (ms) |
Getting Started
- Register a free account at previewship.com
- Create an API Key from the console → API Keys page
- Deploy using any method above
- Share the preview link with your team
Plans
| Free | Pro Monthly | Pro Yearly | |
|---|---|---|---|
| Price | $0 | $5.40/mo launch price (was $9/mo) | $50.40/yr launch price (was $84/yr, $4.20/mo) |
| Projects | 1 | 10 | 20 |
| Daily Deploys | 5 | 30 | 40 |
| Max Zip Size | 15 MB | 50 MB | 80 MB |
| Preview Expiry | 3 days | 30 days | 365 days |
| PreviewShip Watermark | Included | Removed | Removed |
Free plan requires no credit card. Start deploying instantly.
Supported Frameworks
Any static frontend output works — React, Vue, Svelte, Angular, Next.js (export), Nuxt (generate), Astro, vanilla HTML/CSS/JS, Markdown documents, and more. Build output directories should contain an index.html. Single .html files are automatically packaged as index.html; single .md/.markdown files keep their original source and get a generated index.html Markdown viewer when deployed from CLI, MCP, VS Code/Cursor extension, or the web console.
Important: PreviewShip hosts static artifacts; it does not run npm install or build raw source zips after upload. If your project is React/Vue/Next/Astro/etc., run the build command first and upload the generated output folder or zip.
Requirements
- Node.js ≥ 20.0.0 (for CLI and MCP)
- VS Code ≥ 1.85.0 (for extension)
- An API Key from previewship.com
Links
- Website: previewship.com
- Documentation: previewship.com/docs
- CLI on npm: npmjs.com/package/previewship
- MCP on npm: npmjs.com/package/previewship-mcp
- VS Code Marketplace: marketplace.visualstudio.com
- Agent Skills:
skills/
License
MIT — see LICENSE for details.