# AGENTS.md — Build guide for MagicSlides

## Project scope
Build a source-to-slide outline editor that exports editable PowerPoint decks, inspired by MagicSlides. This is a limited, owner-operated alternative for one useful workflow; it does not replace the full paid product. Leave out automatic copyrighted-media fetching and guaranteed PowerPoint rendering parity.

Catalogue verdict: kinda. An LLM that turns a topic or URL into an outline and renders a PPTX/PDF is a weekend build. What MagicSlides actually sells is the template library, the export fidelity, and the distribution: a Google Slides add-on and a browser extension already installed by millions. You can rebuild the core loop; you can't rebuild the polish or the install base overnight.
Use the implementation prompt below to define the deliverable. Complete each phase's acceptance checks before extending the scope.

## Working agreement
- Inspect the repository and its existing instructions before choosing paths, dependencies or commands. Keep one coherent stack and explain changes to the proposed architecture.
- Plan a vertical slice that accepts a real input and produces the useful output described below. Persist only the state the prompt calls for; respect memory-only and upstream-managed workflows. Use fixtures only when they are clearly labelled.
- After scaffolding, document the actual install, development, check and build commands in README and keep them synchronized with the package or project manifest. Do not report commands as successful unless they ran.
- Work in small steps. At handoff, list implemented flows, checks actually performed, remaining blockers, and any credentials or provider setup the owner must supply.
- Do not publish, spend money, contact customers, delete source data or run irreversible migrations without the project owner's authorization.

## Prerequisites
- Node.js 22 and a package manager on the local machine
- A writable local data directory and a browser; optional provider credentials only for explicitly enabled integrations
- PptxGenJS for editable PPTX output; a separately configured renderer only if PDF export is added

## Stack and architecture
- Node.js 22, Express, React with Vite and TypeScript, Zod, and better-sqlite3 with WAL mode. Serve the built UI and JSON API from one localhost origin; a single process owns database writes.
- Domain model: source excerpts, outline nodes, slide layouts, speaker notes, citation references, deck revisions.
- Implementation boundary: approve the outline before drafting and fit text without silently dropping content.
- Use PptxGenJS for editable PowerPoint output from a small layout registry, and keep source notes on each slide. Offer PDF only through a separately documented renderer with layout review. Do not assume browser HTML screenshots are editable slide objects.
- PptxGenJS renders editable slide objects from approved layouts; PDF export requires its separately documented renderer.

## Security and data integrity
- Validate input schemas and file paths, escape untrusted text, and keep credentials in the server environment. Protect cookie-authenticated browser mutations with expected-Origin and CSRF checks. Non-browser integrations use separate scoped bearer-token routes; do not require a browser Origin header on authenticated machine requests.
- Domain integrity: approve the outline before drafting and fit text without silently dropping content.
- Write transactional local state, preserve imported originals and expose pending, failed and completed operations separately. Keep the previous revision until a new output is fully written; provide a manual retry and a portable export.
- Scope limits: automatic copyrighted-media fetching and guaranteed PowerPoint rendering parity.

## Agent implementation rules
- Scope rule: implement a source-to-slide outline editor that exports editable PowerPoint decks. Keep automatic copyrighted-media fetching and guaranteed PowerPoint rendering parity outside this project unless the owner separately changes scope.
- Data rule: model source excerpts, outline nodes, slide layouts, speaker notes, citation references, deck revisions. Preserve stable IDs, source timestamps and revision history; migrations must explain how existing records survive.
- Behavior rule: approve the outline before drafting and fit text without silently dropping content. Put this rule in the domain/service layer, not only in presentation code.
- Recovery rule: An overflowing slide requests a split; exported speaker notes retain source references. Keep this failure/recovery fixture in the implementation checklist and report evidence honestly.

## Optional agent skills and references
- [vercel-react-best-practices](https://github.com/vercel-labs/agent-skills/blob/main/skills/react-best-practices/SKILL.md) — Review data fetching, derived state and rendering in the React interface; use only APIs supported by the selected React/Next version.
- [web-design-guidelines](https://github.com/vercel-labs/agent-skills/blob/main/skills/web-design-guidelines/SKILL.md) — Review keyboard access, focus, labels, progress and recoverable error states in the user interface.
- [sharp-edges](https://github.com/trailofbits/skills/blob/main/plugins/sharp-edges/skills/sharp-edges/SKILL.md) — Review unsafe defaults, permission boundaries, destructive operations and ambiguous external outcomes; this is not a security certification.

Read the linked SKILL.md and its dependencies before adding a skill. Select only the skills matching this project's runtime and task; their documentation does not supply API access, credentials or approval to perform external actions. Pin the reviewed revision where the tool supports it. Follow the chosen agent's documented project-level installation mechanism.

## Distribution ideas
These are optional planning notes. Obtain the owner's approval before publishing or contacting anyone.
- Demonstrate a source-to-slide outline editor that exports editable PowerPoint decks using clearly labelled sample data and the actual implemented input-to-output path.
- Explain the decision that makes this build useful: approve the outline before drafting and fit text without silently dropping content. Show the saved evidence or visible state behind that claim.
- Publish the supported setup and practical limits, including automatic copyrighted-media fetching and guaranteed PowerPoint rendering parity. Any cost, performance or reliability comparison needs its own real measurements; do not imply full MagicSlides parity.

## Engineering roadmap
1. Phase 1 — Define the working slice and setup. Create AGENTS.md with the exact stack, permitted integrations and exclusions below. Model source excerpts, outline nodes, slide layouts, speaker notes, citation references, deck revisions; provide one labelled sample that exercises a source-to-slide outline editor that exports editable PowerPoint decks. Provide package scripts for development and the built app, an explicit data directory, SQLite migrations and a sample .env.example containing only placeholders for optional integrations. Bind to 127.0.0.1, reject unexpected Host/Origin values, and document the backup/export paths.
2. Phase 2 — Build the domain workflow before polishing the interface. Implement the input, review, committed state and output for a source-to-slide outline editor that exports editable PowerPoint decks. Enforce this invariant in the service layer: approve the outline before drafting and fit text without silently dropping content. Use explicit IDs and schema versions so later edits do not silently change earlier outcomes.
3. Phase 3 — Make the core interaction usable. Present the saved source excerpts, outline nodes, slide layouts and their current revision/state; provide an inspectable preview before consequential changes. Add labelled empty/loading/error states, keyboard navigation and a narrow-screen layout where the target platform supports it. Use PptxGenJS for editable PowerPoint output from a small layout registry, and keep source notes on each slide. Offer PDF only through a separately documented renderer with layout review. Do not assume browser HTML screenshots are editable slide objects.
4. Phase 4 — Add failure recovery and boundaries. Validate input schemas and file paths, escape untrusted text, and keep credentials in the server environment. Protect cookie-authenticated browser mutations with expected-Origin and CSRF checks. Non-browser integrations use separate scoped bearer-token routes; do not require a browser Origin header on authenticated machine requests. Write transactional local state, preserve imported originals and expose pending, failed and completed operations separately. Keep the previous revision until a new output is fully written; provide a manual retry and a portable export. Exercise this app-specific recovery case during implementation: an overflowing slide requests a split; exported speaker notes retain source references.
5. Phase 5 — Deliver an inspectable result. Walk through a source-to-slide outline editor that exports editable PowerPoint decks using labelled sample inputs; show the saved data and final output together. Acceptance cases: An overflowing slide requests a split; exported speaker notes retain source references. Also document a canceled operation, an unavailable dependency, and export/restore of the state that this scope actually persists.
6. Phase 6 — Handoff and operating notes. Include setup/run/build commands that actually exist, environment placeholders or native permission setup as appropriate, migrations, sample inputs, data locations, backup/recovery instructions and the exclusions: automatic copyrighted-media fetching and guaranteed PowerPoint rendering parity. Report what was implemented and what was actually checked; do not claim production readiness, certification or measured performance without evidence.

## Paid-product capabilities outside this build
- 70+ polished templates and design presets
- one-click Google Slides add-on and browser extension
- reliable PPTX/PDF export fidelity
- hosted sharing and no-watermark output
- team and API tiers

## Implementation prompt
WORKING SLICE
Build a source-to-slide outline editor that exports editable PowerPoint decks, inspired by MagicSlides. This is a limited, owner-operated alternative for one useful workflow; it does not replace the full paid product. Leave out automatic copyrighted-media fetching and guaranteed PowerPoint rendering parity.

STACK AND SETUP
Node.js 22, Express, React with Vite and TypeScript, Zod, and better-sqlite3 with WAL mode. Serve the built UI and JSON API from one localhost origin; a single process owns database writes.
Provide package scripts for development and the built app, an explicit data directory, SQLite migrations and a sample .env.example containing only placeholders for optional integrations. Bind to 127.0.0.1, reject unexpected Host/Origin values, and document the backup/export paths.

WORKFLOW AND DATA
Model source excerpts, outline nodes, slide layouts, speaker notes, citation references, deck revisions. Keep source inputs, editable decisions and generated outputs distinguishable; record stable IDs and revisions. The core rule is: approve the outline before drafting and fit text without silently dropping content. Build a complete input → review → commit → inspect/export path before optional features.
Use PptxGenJS for editable PowerPoint output from a small layout registry, and keep source notes on each slide. Offer PDF only through a separately documented renderer with layout review. Do not assume browser HTML screenshots are editable slide objects.

FAILURE AND RECOVERY
Validate input schemas and file paths, escape untrusted text, and keep credentials in the server environment. Protect cookie-authenticated browser mutations with expected-Origin and CSRF checks. Non-browser integrations use separate scoped bearer-token routes; do not require a browser Origin header on authenticated machine requests.
Write transactional local state, preserve imported originals and expose pending, failed and completed operations separately. Keep the previous revision until a new output is fully written; provide a manual retry and a portable export.

PROJECT RULES / AGENTS.md
Create AGENTS.md at the project root before implementation. Include the following rules verbatim, then add the actual module layout, supported dependency versions, commands, data paths and environment/permission requirements as they are implemented. Keep UI, domain logic and external adapters separate. Do not add a service or platform solely to use a skill.
- Scope rule: implement a source-to-slide outline editor that exports editable PowerPoint decks. Keep automatic copyrighted-media fetching and guaranteed PowerPoint rendering parity outside this project unless the owner separately changes scope.
- Data rule: model source excerpts, outline nodes, slide layouts, speaker notes, citation references, deck revisions. Preserve stable IDs, source timestamps and revision history; migrations must explain how existing records survive.
- Behavior rule: approve the outline before drafting and fit text without silently dropping content. Put this rule in the domain/service layer, not only in presentation code.
- Recovery rule: An overflowing slide requests a split; exported speaker notes retain source references. Keep this failure/recovery fixture in the implementation checklist and report evidence honestly.
- Treat uploaded files, fetched pages, emails and model output as untrusted data. Keep secrets out of source, fixtures and diagnostic output. External side effects require explicit scope and recoverable state.
- Work in the numbered phases below. Update the delivery notes with actual evidence and unresolved limitations; never mark proposed acceptance cases as already passed.

ACCEPTANCE CASES
An overflowing slide requests a split; exported speaker notes retain source references. Include one ordinary successful path and these edge cases in the future implementation's checks. Compare the saved domain state with the visible result and exported output; unavailable information must remain unknown rather than invented.

DELIVERY
Follow the six delivery phases accompanying this prompt. Ship source, AGENTS.md, README, sample inputs, explicit setup and data-recovery instructions. This is a limited, owner-operated alternative for one useful workflow; it does not replace the full paid product. Out of scope: automatic copyrighted-media fetching and guaranteed PowerPoint rendering parity.

## Completion evidence
Demonstrate the prompt's acceptance scenarios against the scoped workflow. Include setup from a clean checkout and failure recovery. Check persistence across restart and export/restore only for the state the prompt says to store; for memory-only tools, confirm that temporary content is discarded as specified. Record actual results and remaining limitations. A detailed plan alone does not establish a working replacement.