Playwrightium

Model Context Protocol server for browser automation with Playwright

Build reusable browser automation workflows that AI can intelligently select and execute. Stop regenerating the same steps repeatedly—define tested automation once, use everywhere.

🚀 Quick Start

Installation

# Install globally
npm install -g playwrightium

# Or use with npx (no installation needed)
npx playwrightium

MCP Configuration

Add to your MCP settings (VS Code, Claude Desktop, etc.):

{
  "mcpServers": {
    "playwrightium": {
      "command": "npx",
      "args": ["-y", "playwrightium"]
    }
  }
}

That's it! The server will automatically create a .playwright-mcp workspace in your home directory.

Custom Workspace (Optional)

{
  "mcpServers": {
    "playwrightium": {
      "command": "npx",
      "args": [
        "-y",
        "playwrightium",
        "--base",
        "/path/to/your/workspace"
      ]
    }
  }
}

Seed AI Assistant Integration (Optional)

Install chatmodels and prompts for your AI assistant:

# For GitHub Copilot
playwrightium seed --loop=copilot

# For Claude
playwrightium seed --loop=claude

This creates workspace-specific configurations in .github/chatmodels and .github/prompts (Copilot) or .claude/agents (Claude).

Your First Automation

Use the @create-shortcut prompt in your AI assistant:

@create-shortcut Login to my staging environment

The AI will guide you through:

Testing the workflow manually with browser-session
Creating a YAML shortcut with proper selectors
Saving to .playwright-mcp/shortcuts/login.yaml
Testing the final shortcut

🎯 Three Ways to Automate

1. Browser Session (Built-in)

Execute commands directly without creating files:

{
  "tool": "browser-session",
  "commands": [
    { "type": "navigate", "url": "https://example.com" },
    { "type": "fill", "selector": "#email", "value": "user@example.com" },
    { "type": "click", "selector": "button[type='submit']" },
    { "type": "screenshot", "path": "result.png" }
  ]
}

2. Shortcuts (YAML)

Reusable workflows with environment variable support:

# .playwright-mcp/shortcuts/login.yaml
commands:
  - type: navigate
    url: ${{STAGING_URL}}
  
  - type: fill
    selector: "#email"
    value: ${{USER_EMAIL}}
  
  - type: fill
    selector: "#password"
    value: ${{USER_PASSWORD}}
  
  - type: click
    selector: 'button[type="submit"]'
  
  - type: wait_for_text
    text: "Dashboard"

Run with: execute-shortcut { "shortcutPath": "login.yaml" }

3. Scripts (TypeScript/JavaScript)

Advanced automation with full programming capabilities:

// .playwright-mcp/scripts/extract-users.ts
import type { Page } from 'playwright';

export default async function({ page, logger, env }) {
  await page.goto(env.ADMIN_URL);
  
  const users = await page.$$eval('.user-row', rows =>
    rows.map(row => ({
      name: row.querySelector('.name').textContent,
      email: row.querySelector('.email').textContent
    }))
  );
  
  logger(`Extracted ${users.length} users`);
  return { users };
}

Run with: execute-script { "scriptPath": "extract-users.ts" }

🔐 Environment Variables

Keep credentials secure using .env files:

# .env (at repository root)
STAGING_URL=https://staging.example.com
USER_EMAIL=test@example.com
USER_PASSWORD=secure-password
API_KEY=your-api-key

Use in shortcuts: ${{VARIABLE_NAME}}
Use in scripts: env.VARIABLE_NAME

🧰 Built-in Tools

browser-session - Execute 25+ browser commands in one call
execute-shortcut - Run YAML workflow files
execute-script - Run TypeScript/JavaScript automation
browser-snapshot - Capture page state for debugging
browser-debug - Get console logs and network requests
close-browser - Reset browser session

Available Commands

Navigate, click, fill, type, hover, screenshot, scroll, evaluate, wait_for_text, get_text, get_attribute, press_key, select_option, check, uncheck, upload_file, drag, reload, get_url, get_title, and more!

🤖 AI Assistant Prompts

Playwrightium includes built-in prompts to guide automation creation:

`@create-shortcut`

Creates YAML shortcuts with proper testing workflow:

@create-shortcut Login to staging and navigate to user dashboard

`@create-script`

Creates TypeScript scripts with best practices:

@create-script Extract all product data from the admin panel

Both prompts enforce:

✅ Test manually first with browser-session
✅ Use environment variables for credentials
✅ Create file only after successful testing
✅ Include comprehensive error handling

Project-Level Integration

Use playwrightium seed to install chatmodels/agents in your project for team-wide consistency:

playwrightium seed --loop=copilot  # → .github/chatmodels & prompts
playwrightium seed --loop=claude   # → .claude/agents

See Seed Command Documentation for details.

📖 Documentation

Full documentation available in the docs/ directory:

Quick Start Guide - Detailed setup and first automation
Commands Reference - Complete command documentation
Shortcuts Guide - YAML workflow creation
Scripts Guide - TypeScript/JavaScript automation
Secrets Management - Environment variables and security
Custom Actions - Build reusable TypeScript tools
Best Practices - Robust automation patterns
Architecture - How Playwrightium works

🌟 Key Features

🖥️ Headed browser by default - see your automation in action
🔐 Secure secret management - environment variables with ${{VAR}} syntax
🎯 Persistent browser sessions - maintain state across actions
🤖 AI-guided creation - built-in prompts for shortcuts and scripts
📦 Three automation layers - browser commands, shortcuts, and scripts
🔧 TypeScript-first - full type safety and intellisense
⚡ Zero config - works out of the box with sensible defaults
🧪 Test-first workflow - manual testing before file creation

🔄 Development

Local Development

git clone https://github.com/analysta-ai/playwrightium.git
cd playwrightium
npm install
npm run build
npm run dev

Configuration Options

# Headed (default) - watch automation
playwrightium

# Headless - background execution
playwrightium --headless
PLAYWRIGHTIUM_HEADLESS=1 playwrightium

# Custom workspace
playwrightium --base /path/to/workspace --actions .my-actions

# Verbose logging
playwrightium --verbose

� Examples

Quick Search Automation

{
  "tool": "browser-session",
  "commands": [
    { "type": "navigate", "url": "https://google.com" },
    { "type": "fill", "selector": "input[name='q']", "value": "Playwright" },
    { "type": "press_key", "key": "Enter" },
    { "type": "screenshot", "path": "results.png" }
  ]
}

E-commerce Testing Shortcut

# test-checkout.yaml
commands:
  - type: navigate
    url: ${{SHOP_URL}}
  - type: fill
    selector: "#search"
    value: "laptop"
  - type: click
    selector: ".product:first-child"
  - type: click
    selector: "#add-to-cart"
  - type: screenshot
    path: "cart.png"

Data Extraction Script

export default async function({ page, env, logger }) {
  await page.goto(`${env.ADMIN_URL}/reports`);
  
  const data = await page.evaluate(() => {
    return Array.from(document.querySelectorAll('.data-row'))
      .map(row => ({
        date: row.querySelector('.date').textContent,
        revenue: row.querySelector('.revenue').textContent
      }));
  });
  
  logger(`Extracted ${data.length} records`);
  return { data, timestamp: new Date().toISOString() };
}

🔗 Links

NPM Package: https://www.npmjs.com/package/playwrightium
GitHub Repository: https://github.com/analysta-ai/playwrightium
Documentation: ./docs/
Model Context Protocol: https://modelcontextprotocol.io
Playwright: https://playwright.dev

🤝 Contributing

Contributions welcome! Please read our contributing guidelines and submit pull requests to the repository.

Happy automating! 🚀

playwrightium