Excalidraw Export MCP Server

An MCP (Model Context Protocol) server for exporting Excalidraw diagrams to PNG or SVG format.
Features
- Export
.excalidrawfiles to PNG or SVG - Batch export multiple files at once
- Get diagram metadata (element count, types, bounds, etc.)
- Pixel-perfect rendering using headless Chromium browser
- Configurable export options (scale, dark mode, background)
Prerequisites
- Node.js 18 or later
- Playwright (Chromium is downloaded automatically on install)
Installation
npm install
npm run build
On first install, Playwright will download Chromium automatically.
Usage
As an MCP Server
Add to your Claude Desktop config (~/Library/Application Support/Claude/claude_desktop_config.json):
{
"mcpServers": {
"excalidraw-export": {
"command": "node",
"args": ["/path/to/excalidraw-export-mcp/dist/index.js"]
}
}
}
Tools
export_excalidraw
Export a single Excalidraw diagram.
Parameters:
inputPath(required): Absolute path to the.excalidrawfileoutputPath: Output file path (defaults to input path with new extension)format:"png"or"svg"(default:"png")background: Include background color (default:true)darkMode: Export in dark mode (default:false)scale: Scale factor 1, 2, or 3 (default:2for high DPI)
export_excalidraw_batch
Export multiple diagrams at once.
Parameters:
inputPaths(required): Array of absolute paths to.excalidrawfilesoutputDir: Output directory (defaults to same directory as each input)format:"png"or"svg"(default:"png")background,darkMode,scale: Same as above
get_excalidraw_info
Get metadata about an Excalidraw file without exporting.
Parameters:
inputPath(required): Absolute path to the.excalidrawfile
Returns:
elementCount: Number of elements in the diagramelementTypes: Count of each element type (rectangle, arrow, text, etc.)hasBackground: Whether background is exportedbackgroundColor: Background colorversion: Excalidraw schema versionfileSize: File size in bytesbounds: Diagram dimensions (width, height)
Examples
Example 1: Export a Single Diagram to PNG
{
"tool": "export_excalidraw",
"arguments": {
"inputPath": "/Users/me/diagrams/architecture.excalidraw",
"format": "png",
"scale": 2
}
}
Result: ``json { "success": true, "outputPath": "/Users/me/diagrams/architecture.png", "format": "png", "message": "Successfully exported to /Users/me/diagrams/architecture.png" } ``
Example 2: Export with Custom Output Path
{
"tool": "export_excalidraw",
"arguments": {
"inputPath": "/Users/me/docs/flowchart.excalidraw",
"outputPath": "/Users/me/images/flowchart-hires.png",
"scale": 3
}
}
Example 3: Export in Dark Mode
{
"tool": "export_excalidraw",
"arguments": {
"inputPath": "/Users/me/diagrams/network.excalidraw",
"darkMode": true,
"background": true
}
}
Example 4: Export to SVG
{
"tool": "export_excalidraw",
"arguments": {
"inputPath": "/Users/me/diagrams/logo.excalidraw",
"format": "svg"
}
}
Example 5: Batch Export Multiple Diagrams
{
"tool": "export_excalidraw_batch",
"arguments": {
"inputPaths": [
"/Users/me/docs/diagram1.excalidraw",
"/Users/me/docs/diagram2.excalidraw",
"/Users/me/docs/diagram3.excalidraw"
],
"outputDir": "/Users/me/exports",
"format": "png",
"scale": 2
}
}
Result: ``json { "success": true, "results": [ { "inputPath": "/Users/me/docs/diagram1.excalidraw", "outputPath": "/Users/me/exports/diagram1.png", "success": true }, { "inputPath": "/Users/me/docs/diagram2.excalidraw", "outputPath": "/Users/me/exports/diagram2.png", "success": true }, { "inputPath": "/Users/me/docs/diagram3.excalidraw", "outputPath": "/Users/me/exports/diagram3.png", "success": true } ], "totalProcessed": 3, "successful": 3, "failed": 0 } ``
Example 6: Get Diagram Information
{
"tool": "get_excalidraw_info",
"arguments": {
"inputPath": "/Users/me/diagrams/architecture.excalidraw"
}
}
Result: ``json { "elementCount": 15, "elementTypes": { "rectangle": 5, "arrow": 6, "text": 4 }, "hasBackground": true, "backgroundColor": "#ffffff", "version": 2, "source": "https://excalidraw.com", "fileSize": 12453, "bounds": { "width": 800, "height": 600 } } ``
Example 7: Export Without Background (Transparent)
{
"tool": "export_excalidraw",
"arguments": {
"inputPath": "/Users/me/diagrams/icon.excalidraw",
"format": "png",
"background": false
}
}
Claude Code Usage Examples
When using with Claude Code, you can ask:
Export a diagram: > "Export the architecture diagram at /path/to/architecture.excalidraw to PNG"
Export all diagrams in a folder: > "Export all .excalidraw files in the docs folder to PNG format"
Get diagram info before exporting: > "What's in the diagram at /path/to/diagram.excalidraw? How many elements does it have?"
Create high-resolution exports: > "Export diagram.excalidraw at 3x scale for printing"
Dark mode exports: > "Export the network diagram in dark mode"
Development
# Install dependencies
npm install
# Build
npm run build
# Watch mode
npm run dev
# Run all tests
npm test
# Run unit tests only (faster, no browser)
npm run test:unit
# Run integration tests (requires Playwright/Chromium)
npm run test:integration
Test Suite
The project includes a comprehensive test suite:
Unit Tests (tests/get-info.test.ts)
- Element counting and categorization
- Bounds calculation
- AppState property extraction
- Edge cases (empty elements, missing properties)
Schema Validation Tests (tests/mcp-server.test.ts)
- Zod schema validation for all tool inputs
- Default value handling
- Required field validation
- Boundary conditions (scale min/max)
- Tool definition structure validation
Integration Tests (tests/export.test.ts)
- Full export pipeline with Playwright
- PNG file validation (magic bytes check)
- Page reload handling
- Canvas capture
- Batch processing
- Error recovery
To skip integration tests (if Chromium is not installed): ``bash SKIP_INTEGRATION=true npm test ``
How It Works
This server uses Playwright to run a headless Chromium browser that:
- Navigates to excalidraw.com
- Loads your diagram data via localStorage
- Captures a screenshot of the rendered canvas
This approach ensures pixel-perfect rendering identical to the Excalidraw web app.
Troubleshooting
Chromium not installed
If you see "Executable doesn't exist" errors, run: ``bash npx playwright install chromium ``
Timeout errors
For large diagrams, the export may take longer. The server includes automatic retries and page reload handling.
Memory issues with batch exports
For very large batches, consider breaking them into smaller chunks or increasing Node.js memory: ``bash NODE_OPTIONS="--max-old-space-size=4096" node dist/index.js ``
Publishing to npm
Prerequisites
- Create an npm account at https://www.npmjs.com/
- Generate an access token with publish permissions
- Add the token as
NPM_TOKENsecret in GitHub repository settings
Automated Publishing (Recommended)
Publishing is automated via GitHub Actions. To publish a new version:
- Update the version in
package.json:
npm version patch # or minor, major
- Push the changes and create a GitHub release:
git push && git push --tags
- Create a release on GitHub from the tag - this triggers the publish workflow
Manual Publishing
To publish manually:
# Login to npm
npm login
# Build and test
npm run build
npm run test:unit
# Publish
npm publish --access public
Version Guidelines
- Patch (0.1.x): Bug fixes, documentation updates
- Minor (0.x.0): New features, non-breaking changes
- Major (x.0.0): Breaking changes
Using from npm
Once published, users can install directly:
npm install -g excalidraw-export-mcp
Or use with npx:
npx excalidraw-export-mcp
License
MIT











