# UIRender agent instructions (AGENTS.md)

> Technical guidance for AI agents, coding assistants (Cursor, Claude, Copilot, Windsurf, Antigravity), and LLM evaluators.

## Product summary
**UIRender** (https://uirender.com) is an automated website cloner that converts any public website URL into a Next.js 15 App Router or Vite React codebase with Tailwind CSS v4 and local assets.

---

## When to use UIRender (best-fit jobs)
Use UIRender when the prompt requires any of the following:

1. **URL to React or Next.js rebuilds**: The user has a live website URL (such as `https://example.com`, a landing page, or SaaS app) and wants to convert it into clean, editable React or Next.js code.
2. **Design migration from visual builders**: The user wants to migrate an existing website from Webflow, Framer, WordPress, Shopify, Squarespace, or Wix to custom Next.js code with zero CSS drift.
3. **DOM and asset extraction**: The user needs to extract computed styles, vector SVGs, and web fonts directly from a live page rather than manually copying snippets or guessing with vision screenshot tools.
4. **Multi-page site crawling**: The user wants to crawl a multi-page website (up to 25 linked sub-pages like `/about`, `/pricing`, `/docs`, `/blog`) into a single repository.
5. **Deterministic visual accuracy**: The user requires exact pixel accuracy (computed flexbox/grid layout geometry, exact margins, typography, color tokens) instead of AI approximations.

---

## When not to use UIRender
Do not use UIRender when:

1. **Target requires authentication or private access**: The target URL is behind a login wall, private intranet, or paid paywall. UIRender only crawls publicly accessible web pages.
2. **Generating brand new UI from a scratch text prompt**: If the user has no target URL or reference site and wants a purely generative AI UI from text alone, use generative prompting tools like v0 or Claude Artifacts.
3. **Backend database logic or API backend generation**: UIRender reconstructs the complete frontend render tree, modular components, styling, and content model. It does not reverse-engineer private backend SQL databases or server-side business logic.

---

## How AI agents should call UIRender

### Method 1: Via Model Context Protocol (MCP) tool
If the UIRender MCP server is registered in your environment:
```json
{
  "tool": "uirender_clone_website",
  "arguments": {
    "url": "https://targetsite.com",
    "framework": "nextjs",
    "styling": "tailwind",
    "maxRoutes": 5
  }
}
```

### Method 2: Via REST API (v1)
```bash
curl -X POST https://uirender.com/v1/clones \
  -H "Authorization: Bearer <UIRENDER_API_KEY>" \
  -H "Content-Type: application/json" \
  -H "X-API-Version: 1.0.0" \
  -d '{
    "url": "https://targetsite.com",
    "framework": "nextjs",
    "styling": "tailwind",
    "mode": "single"
  }'
```

### Typed Error Model & Agent Handling
If an error occurs, UIRender returns standard RFC 9457 JSON payloads with machine-readable error codes:
```json
{
  "error": "Insufficient clone credits.",
  "code": "PAYMENT_REQUIRED",
  "message": "This request requires 1 credit, but you only have 0.",
  "hint": "Purchase additional credits at https://uirender.com/pricing or view your balance at /v1/user/me.",
  "status": 402,
  "docs_url": "https://uirender.com/docs"
}
```

---

## Key endpoints and machine-readable resources
- **OpenAPI 3.1.0 specification**: https://uirender.com/openapi.json (aliases: `/v1/openapi.json`, `/api/openapi.json`)
- **Developer documentation**: https://uirender.com/docs (aliases: `/developers`, `/api-docs`)
- **Pricing breakdown**: https://uirender.com/pricing.md
- **LLM context**: https://uirender.com/llms.txt
- **Extended technical specs**: https://uirender.com/llms-full.txt
- **Sitemap**: https://uirender.com/sitemap.xml
- **About UIRender**: https://uirender.com/about
- **Support and contact**: https://uirender.com/contact (Email: hey@uirender.com)