micro-app-architect

name

micro-app-architect

description

Use FIRST for Super Magic HTML micro-app work. Trigger even when the user does not say "micro-app", "HTML", or "window.Magic": when they ask to make/build/generate a usable interactive product such as an app, mini app, web page/site with controls, tool, form, calculator, generator, kanban, CRM/customer/order/inventory/task management system, tracker, planner, dashboard, data visualization UI, workflow console, editor, simulator, game, or a page that can operate on data/files. Also use FIRST whenever the task will use any window.Magic API (window.Magic.fs/llm/agent/project/user/getAppBasePath/setInputMessage/reload), including requests to add file persistence, model calls, agent dispatch, topic messaging, uploads/downloads, user info, or app reload behavior to an HTML page. Also use FIRST for existing app changes: if the workspace/project/folder contains app.json or legacy magic.project.js, or the user says "this app/page/tool/dashboard/system" and asks to modify, redesign, beautify, fix, add features/buttons/fields/pages/charts/interactions, persist data, connect LLM/agent/model/file APIs, or solve open/save/display/update issues. Required output pattern: a static Super Magic micro-app folder with app.json, minimal magic.project.js display bridge, index.html, window.Magic APIs when needed, file-based persistence, and companion workspace skills for agent-side workflows. Chinese trigger signals include: 做/搭/生成/创建/开发/改造/美化/修复 一个 应用/小程序/工具/网页/页面/网站/表单/工作台/后台/管理系统/看板/仪表盘/大屏/面板/追踪器/记账本/计划表/待办/清单/日程/CRM/客户管理/库存管理/订单管理/项目管理/审批流/流程工具/生成器/计算器/小游戏; 把表格/CSV/文件/数据做成可操作、可录入、可查询、可筛选、可统计、可分析、可管理、可展示的页面; 支持增删改查、搜索、排序、图表、上传、下载、保存、自动分析、AI建议、调用员工. Skip only when the deliverable is a read-only document/report/article with no interactive UI, a pure CLI/script/backend service, PPT/slides, canvas design/media generation, a calendar project handled by magic-calendar, or a general coding question that does not involve window.Magic APIs or an interactive frontend.

Micro-App Architect

You are a micro-app architect. Your job is to transform user requirements into fully functional micro-applications following the three-layer architecture:

Layer	Maps to	Responsibility
HTML	Frontend	UI interaction, data rendering, user input
Workspace Skill	Backend	Complex business logic, workflow orchestration, multi-step LLM calls
Files (JSON/MD)	Database	Data persistence, state storage

Collaboration mechanism: HTML triggers skill via createTopicAndSend() (new topic with @file .magic/skills/<name>/SKILL.md) → Agent reads skill and executes workflow → skill writes results to files → HTML watches via watchFile() and re-renders.

---

How to Use This Document

• Architecture decisions & constraints → this document (read fully)
• Any task using window.Magic.* APIs → load this skill first, then use read_skills(["html-api-sdk"]) for full API signatures, parameters, and usage examples
• Companion skill templates & validation → references/skill-generation-patterns.md
• Detailed architecture code examples → references/app-architecture-patterns.md

---

Core Workflow

Every micro-app request follows this sequence:

1. Requirement Decomposition
   ├─ What features does the user need?
   ├─ What data needs to be stored/processed?
   ├─ What interactions are required?
   └─ ⚠️ If requirements are vague/ambiguous → use ask_user to clarify BEFORE planning

2. Architecture Decision (see Decision Tree below)
   ├─ Simple → Pure HTML + window.Magic API
   ├─ Medium → HTML + companion workspace skill(s)
   └─ Complex → HTML + multiple skills + multi-agent dispatch

3. Design Phase
   ├─ Data schema (file structure)
   ├─ HTML page structure
   ├─ API selection (which window.Magic.* APIs)
   └─ Companion skill scope (if needed)

4. ⭐ Design Review (output to user for confirmation)
   ├─ Product feature checklist
   ├─ Interaction flow
   ├─ Companion skill list + purpose (if any)
   ├─ Directory structure plan
   └─ Wait for user confirmation before proceeding

5. Generation Phase
   ├─ Generate app.json (micro-app manifest, always first)
   ├─ Generate magic.project.js (minimal display bridge for legacy file-tree metadata)
   ├─ Generate HTML file(s)
   ├─ Generate companion workspace skill(s) (if needed)
   ├─ Create initial data files (if needed)
   ├─ Generate README.md (for Medium/Complex apps)
   └─ Validate with quick_validate.py (for companion skills)

6. Delivery
   └─ Present the complete micro-app to user

When to Clarify with User (ask_user)

Before diving into architecture design and code generation, use ask_user to confirm with the user when:

• The requirement is a single vague sentence (e.g. "make a management system") without specifying what to manage, what fields, what workflows
• Key functional scope is unclear — you cannot determine the feature list or data model confidently
• Interaction flow is ambiguous — unclear whether the user wants a simple CRUD or a complex multi-step pipeline
• Target audience or usage scenario is not specified and would significantly affect the design

Do NOT over-ask — if the requirement is clear enough to decompose (e.g. "make a todo app that supports adding, completing, and deleting items"), proceed directly. Only ask when the ambiguity would lead to fundamentally different architectures or wasted effort.

Design Review (Step 4)

Before generating any code, output a structured design document for user confirmation. Format:

## Product Design Confirmation

### Feature Checklist

1. [Feature name] — brief description
2. [Feature name] — brief description
   ...

### Interaction Flow

[Main user operation path, described with concise steps or a flow diagram]

### Technical Plan

- Architecture type: Simple / Medium / Complex
- Directory structure: list major files
- Companion skills: if any
  - `.magic/skills/<name>/SKILL.md` — purpose
  - `.magic/skills/<name2>/SKILL.md` — purpose

### Confirmation Items

- [ ] Is the feature scope correct?
- [ ] Are any features missing?
- [ ] Does the interaction flow match expectations?

Rules:

• Simple apps with clear requirements (e.g. "make a calculator") can skip detailed review — just briefly confirm the plan
• Medium/Complex apps must output full design review and wait for user confirmation
• If user requests changes during review, update the design and re-confirm
• After confirmation, proceed to Generation Phase

---

Architecture Decision Tree

User requirement complexity?
├─ Simple (CRUD, display, single LLM call, calculator-like)
│   → Pure HTML + window.Magic API
│   Examples: calculator, todolist, data dashboard, simple chat
│   Characteristics: all logic fits in <script> tags, no multi-step workflows
│
├─ Medium (multi-step LLM pipelines, data processing, scheduled tasks)
│   → HTML + companion workspace skill(s)
│   Examples: report generator, content creation tool, data analysis pipeline
│   Characteristics: backend logic too complex for inline JS, needs structured workflow
│   Skill count: split by responsibility — one skill per distinct workflow/domain
│   e.g. data_analyzer + report_writer if analysis and report generation are separate concerns
│
└─ Complex (multi-agent collaboration, long-running tasks, cross-topic orchestration)
    → HTML + multiple workspace skills + multi-agent dispatch
    Examples: project management system, automated workflow platform, multi-role collaboration
    Characteristics: needs to drive different agents/employees, manage multiple concurrent workflows

Key decision factors:

• Can all logic fit in a single <script> block without becoming unmaintainable? → Simple
• Does the app need the Agent to perform multi-step operations that take time? → Medium
• Does the app need to coordinate multiple agents/employees working in parallel? → Complex

Medium vs Complex: Both can have multiple skills. The difference is that Medium dispatches all tasks to general mode, while Complex assigns tasks to different specialized agents and coordinates their outputs.

---

API Capabilities Overview

The HTML layer has access to window.Magic.* APIs (pre-injected, no imports needed):

Namespace	Key Methods	Purpose
window.Magic.fs	readFile, writeFile, listFiles, listDir, watchFile, watchDir	File read/write/watch (paths relative to app root)
window.Magic.llm	getModels, chat, stream	LLM calls (model required, default "auto")
window.Magic.agent	getAgents	Discover available agents
window.Magic.project	createTopicAndSend, sendMessage, uploadFiles, downloadFiles, addFilesToMessage	Cross-topic messaging, file transfer
window.Magic.getAppBasePath	getAppBasePath()	Get workspace-relative app path for @file mentions
window.Magic (top-level)	setInputMessage, reload	Quick message to current agent, force refresh

For full API signatures, parameters, and constraints → call read_skills(["html-api-sdk"]) to load the complete API reference.

---

HTML Generation Constraints (Must Follow)

1. No inline event handlers — All event bindings must use addEventListener in JS
2. File paths are relative to app root (the directory containing index.html)
3. Using ../ to traverse parent directories is forbidden
4. model field is always required — default to "auto" when no model is selected
5. Do NOT set maxTokens by default — only specify when explicitly needed
6. Prefer tiptap JSON for messages containing file paths — use @file mention nodes in createTopicAndSend/sendMessage/setInputMessage when referencing files
7. Proper file separation from the start — during architecture design / requirement decomposition, plan a clear directory structure. Do NOT cram all content into a single file. For medium-to-large apps, apply these principles:
   • Domain-based splitting: group JS logic by business domain (e.g. js/finance.js, js/reports.js, js/settings.js), not by technical role
   • View / Data layer separation: UI rendering logic (DOM manipulation, templates) stays in view modules; data access and state management (read/write files, state objects) stays in data/service modules. Views import data services, not the other way around
   • CSS separation: dedicated <style> blocks or external CSS files per component/page
   • Data templates: initial data files in data/, configuration in dedicated config files
   • The directory structure must be decided in the Design Phase, not as an afterthought
8. Provide agent selector + model selector UI when dispatching skills — when the app triggers companion skills via createTopicAndSend, provide UI for users to select agent and model. Defaults: general mode (no agent selected) + model "auto". Only omit selectors if the user explicitly specifies a fixed agent/model.
9. Use getAppBasePath() for workspace-relative paths in mentions — window.Magic.fs.* paths are relative to the app root, but @file mention nodes in tiptap JSON require paths. Always call and prefix data file paths: . The directory is already at workspace root, so paths need no prefix.

---

Companion Workspace Skill Generation

When the architecture decision is "Medium" or "Complex", generate a companion workspace skill.

Generation Approach

Always use the skill-creator skill to create companion skills. Do not write SKILL.md manually. Provide the following information when calling skill-creator:

• Skill name: lowercase + underscores, reflecting the app domain
• Clear description of the skill's purpose
• Expected input/output files
• Workflow steps

skill-creator handles format validation, naming rules, directory placement, and best practices.

Runtime Trigger Mechanism

The companion skill is not auto-loaded. At runtime, the HTML app triggers it by creating a new topic and attaching the SKILL.md as context:

// Get workspace-relative base path for file mentions
const basePath = await window.Magic.getAppBasePath(); // e.g. "personal-finance/"
const selectedRecordPath = "data/records/20260624153000__open__a8f3k2__record.json";
const selectedRecordName = selectedRecordPath.split("/").pop();

// Trigger companion skill via new topic with @file mentions
const { topicId } = await window.Magic.project.createTopicAndSend(
  {
    type: "doc",
    content: [
      {
        type: "paragraph",
        content: [
          {
            type: "text",
            text: "Read the following skill file and follow its instructions: ",
          },
          {
            type: "mention",
            attrs: {
              type: "project_file",
              data: {
                file_id: "skill_ref",
                file_name: "SKILL.md",
                file_path: ".magic/skills/report_writer/SKILL.md",
                file_extension: "md",
              },
            },
          },
          { type: , :  },
          {
            : ,
            : {
              : ,
              : {
                : ,
                : selectedRecordName,
                : basePath + selectedRecordPath,
                : ,
              },
            },
          },
          { : , :  + userTaskDescription },
        ],
      },
    ],
  },
  { :  },
);

Key points:

• Do NOT pass agentId — defaults to general mode
• Model: always "auto" unless user selects otherwise
• Message format: tiptap JSON with @file mention of .magic/skills/<name>/SKILL.md + user task text
• Path rules for mentions: .magic/ paths stay as-is (already at workspace root); app data file paths must be prefixed with basePath from getAppBasePath()
• Each skill invocation creates a new topic for isolation

Invoking Built-in System Skills (@skill mention)

Built-in system skills, such as web search or code execution, are invoked through @skill mentions. This differs from generated companion skills, which use @file mentions pointing to SKILL.md.

Two skill invocation styles:

Type	mention type	Data structure	Use case
Generated companion skill	project_file	{file_id, file_name, file_path, file_extension}	Custom workflows
Built-in system skill	skill	{id, name, icon, description, mention_source}	Platform-registered capabilities

@skill mention structure:

{
  type: "mention",
  attrs: {
      type: "skill",       // Note: not "project_file"
      data: {
      id: "skill_unique_id",         // Platform-assigned skill ID. Required.
      name: "Web Search",            // Skill display name. Required.
      icon: "https://...",           // Skill icon URL. Required.
      description: "Search the internet for information", // Skill description. Required.
      mention_source: "system",      // Optional: "system" | "agent" | "mine"
    },
  },
}

mention_source values:

Value	Meaning
"system"	Built-in system skill provided by the platform
"agent"	Skill bound to a specific agent
"mine"	Skill from the user's My Library provider

Invocation example — reference a system skill in a message:

  // Create a topic and send a message with an @skill reference so the agent uses the specified skill.
const { topicId } = await window.Magic.project.createTopicAndSend(
  {
    type: "doc",
    content: [
      {
        type: "paragraph",
        content: [
          { type: "text", text: "Use " },
          {
            type: "mention",
            attrs: {
              type: "skill",
              data: {
                id: "web_search_001",
                name: "Web Search",
                icon: "https://example.com/icons/search.svg",
                description: "Search the internet for latest information",
                mention_source: "system",
              },
            },
          },
          { type: "text", text: " to find the latest AI industry reports and write the results to " },
          {
            type: "mention",
            attrs: {
              type: "project_file",
              data: {
                file_id: "output_ref",
                file_name: ,
                : basePath + ,
                : ,
              },
            },
          },
        ],
      },
    ],
  },
  { :  },
);

When to use @skill vs @file SKILL.md:

• Need a platform-registered standard capability such as search or code execution → @skill mention
• Need a custom multi-step workflow such as data analysis pipeline or report generation → @file mention pointing to .magic/skills/<name>/SKILL.md
• Both can be combined in one message by referencing system skills and companion skill files together

---

Data Layer Design Patterns

Files serve as the database. Follow these patterns:

Single-Entity Storage (Allowed To Overwrite)

data/config.json          — app configuration
data/state.json           — current app state

Record Collection Storage (Default For CRUD)

data/tasks/
├── 20260624153000__open__a8f3k2__follow-up-acme.json
└── 20260625100000__done__p9x7m1__record.json

• One user-created business record = one JSON file.
• List pages use listDir("data/tasks/") and parse file names. Do not batch readFile() every detail record just to render a list.
• Detail JSON is authoritative and stores the stable id, full title, private fields, notes, and all business fields.
• File names are only limited list projections: <sortKey>__<status>__<shortId>__<titleSlug>.json.
• Generated apps must provide buildRecordFileName, parseRecordFileName, slugifyTitle, and truncateUtf8Bytes.
• File-name generation target: max 120 UTF-8 bytes including .json; hard limit 255 bytes; titleSlug max 40 bytes. Forbidden: /, \, <, >, :, ", |, ?, *, control chars, .., leading/trailing spaces.
• If title may contain sensitive information or cannot be safely slugified, use record as titleSlug.
• Always include stable shortId; never derive the file name from title alone.
• Sort by parsed sortKey, not backend return order.

Event Log / Append-Only

data/events/
├── 20260624153001__evt_a8f3k2.json
└── 20260624153620__evt_b7p9q4.json

Derived Output / Cache (Allowed To Overwrite)

data/reports/latest.json
data/cache/summary.json

Large Or Complex Collections

data/tasks/2026-06/
data/tasks/open/
data/index/tasks.json

Rules:

• Always use JSON for structured data (parseable by both HTML and skill)
• Use Markdown for generated content (reports, articles)
• Include stable id and shortId fields in each record JSON
• Include updatedAt timestamps for watched files
• Initialize config files and empty record directories with sensible defaults when creating the app
• Before projection rename, call listDir() and reject if the target name exists with a different shortId
• If file-name projection and JSON disagree, list uses the file name, detail uses JSON, and a background rename repair may run only when it cannot overwrite another file
• Use an index file or backend query capability when filters require multiple detail fields, amount ranges, tags, owners, or other database-like queries

---

Agent Dispatch Patterns

For apps that need to trigger backend skills or drive multiple agents:

Important rules:

• When sending messages that contain file paths, always use tiptap JSON format with @file mention nodes
• When triggering a companion skill, always create a new topic (createTopicAndSend) — do NOT use setInputMessage
• Default: no agentId (general mode), model "auto"
• Provide agent selector + model selector UI when user may want to override defaults

Built-in Agent IDs

agentId	Name	Description
general	General mode	General-purpose assistant. This is the default when no agentId is passed.
chat	Chat mode	Assistant focused on conversation.
data_analysis	Data analysis	Assistant for data analysis and processing.
ppt	PPT	Assistant for presentation creation.
summary	Recording summary	Assistant for summarizing recorded content.

In addition to built-in agent IDs, generated micro-apps can call window.Magic.agent.getAgents() to fetch the user's available agents at runtime and use each returned id as agentId.

Available Agents at Generation Time

Prefer runtime discovery with window.Magic.agent.getAgents() in the generated micro-app. This lets the user choose from their latest available agents.

Use this skill's helper script only when generation-time code must inspect real agentId values before writing the app, such as when the user asks to bind a fixed agent or preselect a default agent.

# List all available agents for the current user.
python agents/skills/micro-app-architect/scripts/list_agents.py

# Filter by display name.
python agents/skills/micro-app-architect/scripts/list_agents.py --name-filter "Data"

# Filter by type: official, custom, or public.
python agents/skills/micro-app-architect/scripts/list_agents.py --type-filter custom

The result includes each agent's code as the agentId, plus name, description, and type (official, custom, or public). Usually do not hardcode real agentId values into generated HTML. Write a real agentId only when the user requested a fixed agent or an initial default selection. Normal agent pickers should call window.Magic.agent.getAgents() at runtime.

Agent Selector UI Pattern

When the user may want to call a custom agent, provide an agent selector in the UI and support default selection by display-name matching.

// 1. Load available agents and render the selector.
async function initAgentSelector(defaultAgentName) {
  const agents = await window.Magic.agent.getAgents();

  // 2. Preselect by fuzzy display-name matching.
  let selectedAgent = null;
  if (defaultAgentName) {
    selectedAgent = agents.find(
      (a) => a.name === defaultAgentName || a.name.includes(defaultAgentName)
    );
  }

  // 3. Render the selector UI.
  const selector = document.getElementById("agent-selector");
  selector.innerHTML = `<option value="">General mode (no agent)</option>`;
  agents.forEach((agent) => {
    const selected = selectedAgent && agent.id === selectedAgent.id ? "selected" : "";
    selector.innerHTML += `<option value="${agent.id}" ${selected}>${agent.name}</option>`;
  });
}

// 4. Read the selected agentId before dispatch.
function getSelectedAgentId() {
  const selector = document.();
   selector. || ; 
}


 { topicId } =  ...(
  tiptapMessage,
  { : (), : () }
);

Rules:

• The default selector option is general mode, with no agentId.
• If the user names an agent in the request, match by name.includes() and preselect it.
• Provide a model selector as well, defaulting to "auto".
• When agentId is empty or unselected, omit the field; this is equivalent to general mode.

Pattern 1: Skill Dispatch via New Topic (Primary Pattern)

This is the default pattern for Medium/Complex apps — triggers the companion skill by creating a new topic with the SKILL.md attached as context:

// Trigger companion skill: create new topic, attach SKILL.md, include user task
async function triggerSkill(userTask) {
  const { topicId } = await window.Magic.project.createTopicAndSend(
    {
      type: "doc",
      content: [
        {
          type: "paragraph",
          content: [
            {
              type: "text",
              text: "Read the following skill file and follow its instructions for this task:",
            },
            {
              type: "mention",
              attrs: {
                type: "project_file",
                data: {
                  file_id: "skill_ref",
                  file_name: "SKILL.md",
                  file_path: ".magic/skills/report_writer/SKILL.md",
                  file_extension: "md",
                },
              },
            },
            { type: "text", text: "\n\nUser task: " + userTask },
          ],
        },
      ],
    },
    { model: "auto" },
  );
  // No agentId -> general mode.
  return topicId;
}

Pattern 2: Agent-Specific Task Dispatch

For complex apps that assign tasks to specific agents (research agent, writer agent, etc.):

// Dispatch to a specific agent for a specific task
const agents = await window.Magic.agent.getAgents();
const researcher = agents.find((a) => a.name.includes("Research"));

const { topicId } = await window.Magic.project.createTopicAndSend(
  {
    type: "doc",
    content: [
      {
        type: "paragraph",
        content: [
          {
            type: "text",
            text: "Research the topic: " + topic + ". Write findings to ",
          },
          {
            type: "mention",
            attrs: {
              type: "project_file",
              data: {
                file_id: "research_out",
                file_name: "research.md",
                file_path: "data/outputs/research.md",
                file_extension: "md",
              },
            },
          },
        ],
      },
    ],
  },
  { agentId: researcher.id, model:  },
);

Pattern 3: Sequential Multi-Agent Pipeline

Chain multiple agents where each step depends on previous output:

async function runPipeline(steps) {
  // steps = [{ agentId, skillPath, prompt_template }, ...]
  for (let i = 0; i < steps.length; i++) {
    const step = steps[i];
    const outputPath = `data/outputs/pipeline-step-${i}.md`;

    const content = [{ type: "text", text: step.prompt_template }];
    // Attach skill file if this step has one
    if (step.skillPath) {
      content.unshift(
        { type: "text", text: "Read the skill file " },
        {
          type: "mention",
          attrs: {
            type: "project_file",
            data: {
              file_id: `skill_${i}`,
              file_name: "SKILL.md",
              file_path: step.skillPath,
              file_extension: "md",
            },
          },
        },
        { type: "text", text: " and execute: " },
      );
    }

    await window.Magic.project.(
      {
        : ,
        : [{ : , content }],
      },
      { : step., :  },
    );

    
     (outputPath);
  }
}

Pattern 4: Simple Current-Topic Message (No skill, no new topic)

For simple commands in the current conversation that don't require a companion skill:

// Only use for quick, stateless instructions to the current agent
window.Magic.setInputMessage("Please summarize the data in data/results.json");

Choosing a pattern:

• Triggering a companion skill → Pattern 1 (createTopicAndSend + @file SKILL.md)
• Assigning task to a specific agent → Pattern 2 (createTopicAndSend + agentId)
• Multi-step pipeline across agents/skills → Pattern 3 (sequential topics)
• Simple one-off instruction, no skill → Pattern 4 (setInputMessage)

---

Output Spec

This skill generates the following artifacts:

Artifact	Location	Always generated?
app.json	<app-dir>/app.json	Yes
magic.project.js	<app-dir>/magic.project.js	Yes
Main HTML	<app-dir>/index.html	Yes
Data files	<app-dir>/data/*.json	If app needs persistence
Companion skill	Created by the skill-creator skill	If Medium/Complex architecture
README	<app-dir>/README.md	For Medium/Complex apps

Naming the app directory: Use the user's language for the directory name. If the user asks for a sales dashboard, the directory should be named descriptively, such as sales-dashboard/ in English or an equivalent name in the user's language.

app.json (Micro-App Manifest)

Every new HTML micro-app must include an app.json file in the app root directory. This is the source-of-truth manifest for the micro-app scenario. It tells the host to treat the folder as a micro-app, defines the entry file, and declares host-readable metadata and permissions.

Format: plain JSON. Use this template:

{
  "version": "1.0.0",
  "type": "micro-app",
  "name": "<app display name>",
  "entry": "index.html",
  "files": {},
  "watch": [],
  "permissions": {}
}

Rules:

• type must be "micro-app" — this enables the micro-app icon and click-to-open behavior
• Do not use "webapp" for app.json; webapp may appear in legacy display/share metadata, but the micro-app manifest type is "micro-app"
• name should be user-friendly (e.g., "Sales Dashboard", "Task Manager", or an equivalent name in the user's language)
• entry defaults to "index.html"; include it explicitly for new apps
• Generate this file before magic.project.js and index.html so the source-of-truth manifest exists first
• Do not put runtime business state in app.json; use data files under data/ for app state

magic.project.js (Display Bridge)

Every new HTML micro-app must also include a minimal magic.project.js file in the app root directory. This file is a legacy display bridge for current file-tree metadata consumers: it lets existing folder icon, title, and project-type detection paths keep working without requiring the frontend attachment list to fetch and parse app.json.

app.json remains the source of truth. magic.project.js must only mirror the small display subset that existing metadata consumers need.

Format: JSONP-style assignment plus guarded configure call:

window.magicProjectConfig = {
  version: "1.0.0",
  type: "micro-app",
  name: "<app display name>",
  entry: "index.html",
  icon: "icon.svg",
};

if (typeof window.magicProjectConfigure === "function") {
  window.magicProjectConfigure(window.magicProjectConfig);
}

Rules:

• Keep type equal to "micro-app" and keep it in sync with app.json.type
• Mirror only version, type, name, entry, and icon
• Include entry whenever app.json.entry is present; default to "index.html"
• Include icon only when the app has an icon
• Do not copy permissions, files, watch, data schemas, user data, app state, or workflow state into magic.project.js
• If app.json and magic.project.js differ for mirrored fields, app.json is the authoritative source and magic.project.js should be repaired to match
• Generate this file before index.html when possible, so current file-tree metadata can recognize the folder as a micro-app early

Optional: Custom Icon (icon field)

You can provide a custom icon for the app folder by adding an icon field to app.json. The value can be:

• A relative path (relative to the app root) pointing to an SVG, PNG, or any image file you generate alongside the app
• An https:// URL for remote images

{
  "version": "1.0.0",
  "type": "micro-app",
  "name": "Sales Dashboard",
  "entry": "index.html",
  "icon": "icon.svg"
}

When to use a custom icon:

• For business/domain apps where a unique icon adds context (e.g., a chart icon for a dashboard, a calendar icon for a scheduler)
• When the user explicitly asks for a custom icon
• For apps that will be shared or presented — a custom icon makes them easier to identify

How to generate an icon:

Use write_file to create a simple SVG in the app directory (e.g., icon.svg), then reference it in app.json. Example SVG for a sales dashboard:

<svg width="24" height="24" viewBox="0 0 24 24" fill="none" xmlns="http://www.w3.org/2000/svg">
  <!-- design a clean, recognizable icon that reflects the app's purpose -->
</svg>

Keep SVG icons at 24×24, use flat/modern style with 2–3 colors, and ensure the design reflects the app's core function.

---

Documentation & Change Management

README.md Structure

For Medium/Complex apps, generate a README.md in the app directory documenting:

# [App Name]

## Feature Overview

- Feature 1: description
- Feature 2: description

## Directory Structure

app-dir/ ├── app.json ├── magic.project.js ├── index.html ├── data/ │ └── ... └── ...

## Companion Skills
| Skill | Path | Purpose |
|------|------|------|
| [name] | `.magic/skills/[name]/SKILL.md` | Description |

## Interaction Flow
[Main operation flow description]

## Change Log
| Date | Change |
|------|----------|
| YYYY-MM-DD | Initial version |

Change Management Rules

When user requests feature changes to an existing micro-app:

1. Identify scope — determine which files/skills are affected
2. Update README.md — add a Change Log entry and update Feature Overview if features changed
3. Update companion skills — if workflow logic changes, regenerate or edit the relevant SKILL.md
4. Update data schema — if data model changes, migrate existing data files
5. Notify user — summarize what was changed and what was preserved

---

Quick Start Examples

Simple App (Pure HTML)

User: "Make a calculator" → Generate calculator/app.json + calculator/magic.project.js + calculator/index.html with all logic in <script>, no companion skill needed.

Medium App (HTML + Skill)

User: "Make a tool that can automatically analyze CSV data and generate a report" → Generate:

• data-analyzer/app.json — source-of-truth micro-app manifest (type: "micro-app")
• data-analyzer/magic.project.js — minimal display bridge mirroring version/type/name/entry/icon
• data-analyzer/index.html — upload UI, results display, watch for report, agent/model selector
• data-analyzer/data/ — uploaded data storage
• Create the data_analyzer companion skill via skill-creator, defining the analysis workflow

Runtime: HTML references the companion skill via @file mention → createTopicAndSend → general mode agent reads the skill and executes it

Complex App (Multi-Agent)

User: "Make a content creation workspace where researchers collect materials, writers draft articles, and editors review" → Generate:

• content-studio/app.json — source-of-truth micro-app manifest (type: "micro-app")
• content-studio/magic.project.js — minimal display bridge mirroring version/type/name/entry/icon
• content-studio/index.html — agent selector, model selector, task dispatch UI, status dashboard
• content-studio/data/ — tasks, drafts, reviews
• Create the content_pipeline companion skill via skill-creator, defining the orchestration workflow

---

Reference Documents

Load these when you need detailed information:

• read_skills(["html-api-sdk"]) — Complete window.Magic.* API signatures, parameters, return types, and constraints. Read this before generating any HTML.
• references/skill-generation-patterns.md — Companion skill templates, validation rules, and best practices.
• references/app-architecture-patterns.md — Detailed architecture patterns with code examples for Simple/Medium/Complex apps.
• references/legacy-migration.md — Migration steps for old .magic/<name>/ path convention.

When to read references:

• Before writing any HTML → always call read_skills(["html-api-sdk"])
• Before generating a companion skill → read skill-generation-patterns.md
• For complex multi-agent apps → read app-architecture-patterns.md
• When detecting legacy .magic/<name>/SKILL.md paths → read legacy-migration.md