polotno-sdk

Polotno AI Rules

AI coding rules and assistant plugins for Polotno SDK — works with Claude Code, Cursor, GitHub Copilot, Codex, Windsurf, and more.

Gives your AI assistant knowledge of Polotno's Store API, Page API, Element types, UI components, customization patterns, and common gotchas.

Setup

Claude Code (recommended — richest experience)

Install the plugin for automatic skill loading and live documentation search via MCP:

# 1. Add the marketplace
claude plugin marketplace add polotno-project/polotno-ai-rules

# 2. Install the plugin
claude plugin install polotno-sdk@polotno-sdk

Or from within a Claude Code session:

/plugin marketplace add polotno-project/polotno-ai-rules
/plugin install polotno-sdk@polotno-sdk

This gives you:

• Polotno SDK skill — auto-triggered with API patterns and code examples
• MCP documentation server — live search of the latest Polotno docs
• Auto-updates on Claude Code startup

All Other Platforms

Install using the skills CLI — supports 40+ AI coding agents including Cursor, Copilot, Codex, Windsurf, Cline, and more:

npx skills add polotno-project/polotno-ai-rules

The CLI auto-detects which agents you have and installs the skill for all of them.

Manual Setup

Copy rules/polotno-rules.md from this repo to the appropriate location:

Platform	Destination in your project
Cursor	.cursorrules
Copilot	.github/copilot-instructions.md
Codex/Jules	AGENTS.md
Windsurf	.windsurfrules

What's Included

Cross-Platform Rules

All platform files contain the same comprehensive Polotno SDK knowledge:

• Store API — createStore, pages, sizing, selection, grouping, undo/redo, JSON import/export, image/PDF/SVG/HTML/GIF export
• Page API — addElement, set, clone, children, sizing
• Element types — text, image, SVG, figure, line, video, group with full property examples
• UI Components — Workspace, Toolbar, SidePanel, PagesTimeline, ZoomButtons, PolotnoContainer
• Customization — custom side panels, images grids, toolbar components, custom fonts
• Common gotchas — custom attribute, isAlive guard, waitLoading, Blueprint CSS, MobX observer pattern

Claude Code Plugin (additional features)

• Dedicated skill with detailed API reference and coding guidance
• MCP server for live Polotno documentation search
• Auto-triggered when working with Polotno code

Source of Truth

All content is generated from rules/polotno-rules.md. Platform-specific files (.cursorrules, AGENTS.md, etc.) are not in the repo — they're generated at setup time by the CLI.

To update the rules, edit rules/polotno-rules.md and run npm run build to regenerate the Claude plugin's API reference.

Documentation

• Full Polotno SDK docs: https://polotno.com/docs
• API keys: https://polotno.com/cabinet/

License

MIT