Quick Reference

Fast access to essential information for Puppeteer MCP developers and users.

Reference Sheets

API Cheatsheet

Quick API reference for all protocols:

REST endpoints summary
WebSocket events
gRPC methods
Common parameters
Response formats

Common Patterns

Frequently used code patterns:

Authentication flows
Session management
Error handling
Browser automation
Resource cleanup

Environment Variables

Complete environment configuration:

Required variables
Optional settings
Default values
Security considerations
Performance tuning

Error Codes

Comprehensive error reference:

Error code meanings
Common causes
Resolution steps
Prevention tips
Troubleshooting guide

MCP Tools Summary

Model Context Protocol tools:

Available tools list
Parameter reference
Usage examples
Integration patterns
Best practices

Quick Links

Most Used References

By Protocol

REST: Endpoints | Authentication
WebSocket: Events | Connection
gRPC: Services | Client Setup
MCP: Tools | Integration

Common Tasks Quick Reference

Starting a Session

// REST
POST /api/sessions
{ "options": { "headless": true } }

// WebSocket
ws.send({ type: 'create_session', options: { headless: true } })

// gRPC
client.createSession({ options: { headless: true } })

// MCP
puppeteer_create_session({ headless: true })

Navigating to URL

// REST
POST /api/sessions/:id/navigate
{ "url": "https://example.com" }

// WebSocket
ws.send({ type: 'navigate', sessionId, url: 'https://example.com' })

// gRPC
client.navigate({ sessionId, url: 'https://example.com' })

// MCP
puppeteer_navigate({ sessionId, url: 'https://example.com' })

Taking Screenshot

// REST
POST /api/sessions/:id/screenshot
{ "fullPage": true }

// WebSocket
ws.send({ type: 'screenshot', sessionId, fullPage: true })

// gRPC
client.screenshot({ sessionId, fullPage: true })

// MCP
puppeteer_screenshot({ sessionId, fullPage: true })

Error Quick Reference

Common HTTP Status Codes

400 - Bad Request (invalid parameters)
401 - Unauthorized (missing/invalid auth)
404 - Not Found (session/resource not found)
429 - Too Many Requests (rate limited)
500 - Internal Server Error

Common Error Codes

SESSION_NOT_FOUND - Invalid session ID
BROWSER_ERROR - Puppeteer operation failed
TIMEOUT_ERROR - Operation timed out
VALIDATION_ERROR - Invalid input parameters
AUTH_ERROR - Authentication failed

Environment Variables Quick Reference

Essential Variables

# Required
NODE_ENV=production
PORT=3000
JWT_SECRET=your-secret-key

# Recommended
SESSION_TIMEOUT=300000
MAX_SESSIONS=10
RATE_LIMIT=100

Security Variables

# Authentication
JWT_EXPIRES_IN=1h
API_KEY_HEADER=x-api-key

# Security Headers
CORS_ORIGIN=https://example.com
CSP_POLICY=default-src 'self'

Performance Quick Tips

Session Management

Keep sessions alive with regular actions
Close sessions when done
Reuse sessions when possible
Monitor resource usage

Browser Optimization

Use headless mode in production
Disable unnecessary features
Implement proper timeouts
Clean up resources

Debugging Quick Reference

Enable Debug Logging

DEBUG=* npm run dev              # All debug
DEBUG=puppeteer:* npm run dev    # Puppeteer only
DEBUG=mcp:* npm run dev          # MCP only

Common Debug Commands

npm run typecheck    # Check TypeScript
npm run lint        # Run ESLint
npm test           # Run tests
npm run build      # Build project

Protocol Comparison

Feature	REST	WebSocket	gRPC	MCP
Real-time	❌	✅	❌	❌
Streaming	❌	✅	✅	❌
Type Safety	❌	❌	✅	✅
Browser Support	✅	✅	❌	❌
AI Integration	❌	❌	❌	✅

Need More Detail?

Pro Tip: Bookmark this page for quick access to essential information during development!