# AGENTS.md — Build guide for Sumora

## Project scope
Research a reviewed company target from permitted pages, draft a short evidence-grounded email and pause at a visible approval gate before sending.

Catalogue verdict: kinda. The visible surface, a prompt box that produces a researched, personalized outreach message, is a one-sitting build. What takes real work is everything that keeps an agent from quietly going insane on step seven: persistent memory about your business and each contact, retries, browser sessions that survive logins and captchas, cost ceilings, and a human approval gate before anything is actually sent. For one person automating their own pipeline, you can get to genuinely useful in a weekend because you are allowed to be the approval step and the error handler. The gap widens fast the moment you want it unattended, multi-user, or connected to a real CRM and mailbox over OAuth. The failure mode also matters: a broken personal script wastes your evening, a broken agent emails the wrong prospect from your domain.
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
- Runtime and tools: TypeScript, Node, better-sqlite3, Playwright and Hono with server-rendered HTML/htmx; no React or ORM.
- Before starting: A reviewed business brief, authorized target URLs, configured model and mail provider credentials and a small local run database.

## Stack and architecture
- TypeScript, Node, better-sqlite3, Playwright and Hono with server-rendered HTML/htmx; no React or ORM
- Data design: Store BusinessContext, Target, Run, Step, EvidenceQuote, DraftRevision and SendReceipt; approval covers recipient plus exact draft revision and cannot authorize later edits.
- Setup: A reviewed business brief, authorized target URLs, configured model and mail provider credentials and a small local run database

## Security and data integrity
- Keep source evidence, model/config version, draft output and reviewer changes separately. Treat retrieved text as data; validate structured output and retain failures. Never silently send private material to a fallback provider.
- Keep the simple local Hono/htmx architecture and one bounded research loop. Model-provider calls and SMTP leave the host; 'local runner' must not be described as no cloud processing.
- Keep secrets outside client bundles and exported projects; document what leaves the device and make retention/deletion controls visible.

## Agent implementation rules
- Project rule — domain: Store BusinessContext, Target, Run, Step, EvidenceQuote, DraftRevision and SendReceipt; approval covers recipient plus exact draft revision and cannot authorize later edits.
- Project rule — scope and recovery: Keep the simple local Hono/htmx architecture and one bounded research loop. Model-provider calls and SMTP leave the host; 'local runner' must not be described as no cloud processing.
- Project rule — acceptance: Edit the recipient after approval and simulate a send timeout; invalidate the approval and mark the attempt unknown instead of automatically resending.
- Project rule — delivery: document real setup commands and permissions; do not claim a build, accuracy level, performance result or security certification that has not been demonstrated.

## Optional agent skills and references
- Recommended skill: [sharp-edges](https://github.com/trailofbits/skills/blob/main/plugins/sharp-edges/skills/sharp-edges/SKILL.md) — review configuration and API defaults against the app-specific invariants and recovery boundaries above; this is not a security certification. Follow the maintainer's installation instructions and match its requirements to the chosen runtime.
- Recommended skill: [web-design-guidelines](https://github.com/vercel-labs/agent-skills/blob/main/skills/web-design-guidelines/SKILL.md) — review keyboard access, focus, validation, error recovery and the readable work/review interface or HTML report. Follow the maintainer's installation instructions and match its requirements to the chosen runtime.
- Recommended skill: [copywriting](https://github.com/coreyhaines31/marketingskills/blob/main/skills/copywriting/SKILL.md) — write clear, evidence-grounded draft copy or notifications without invented claims; sending/publishing remains separately approved. Follow the maintainer's installation instructions and match its requirements to the chosen runtime.

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 this working slice using synthetic or explicitly authorized non-sensitive examples: Research a reviewed company target from permitted pages, draft a short evidence-grounded email and pause at a visible approval gate before sending.
- Share a synthetic example export and the acceptance walkthrough; keep real customer, health, financial and source data private: Edit the recipient after approval and simulate a send timeout; invalidate the approval and mark the attempt unknown instead of automatically resending.
- State the limits before asking someone to replace their existing tool: Keep the simple local Hono/htmx architecture and one bounded research loop. Model-provider calls and SMTP leave the host; 'local runner' must not be described as no cloud processing.

## Engineering roadmap
1. Phase 1 — Pin the working slice and create its example input: Research a reviewed company target from permitted pages, draft a short evidence-grounded email and pause at a visible approval gate before sending. Confirm setup: A reviewed business brief, authorized target URLs, configured model and mail provider credentials and a small local run database.
2. Phase 2 — Implement persistence and write-time invariants before decorating the UI: Store BusinessContext, Target, Run, Step, EvidenceQuote, DraftRevision and SendReceipt; approval covers recipient plus exact draft revision and cannot authorize later edits.
3. Phase 3 — Connect the working view to real saved state. Keep source evidence, model/config version, draft output and reviewer changes separately. Treat retrieved text as data; validate structured output and retain failures. Never silently send private material to a fallback provider.
4. Phase 4 — Expose the app-specific limits and recovery path in context: Keep the simple local Hono/htmx architecture and one bounded research loop. Model-provider calls and SMTP leave the host; 'local runner' must not be described as no cloud processing.
5. Phase 5 — Walk through this concrete acceptance case and preserve its exported evidence: Edit the recipient after approval and simulate a send timeout; invalidate the approval and mark the attempt unknown instead of automatically resending. Finish the README and backup/restore instructions; report unfinished capabilities explicitly.

## Paid-product capabilities outside this build
- Unattended reliability: retries, resumable runs, and recovery when a step fails halfway through
- Maintained integrations and OAuth to CRMs, mailboxes, and calendars, plus keeping them working when those APIs shift
- Sandboxed execution and guardrails so a confused agent cannot take a real action against a real person
- Cost control and model routing, so one runaway loop does not become a surprise bill
- Deliverability and sending reputation work, which is its own unglamorous specialty

## Implementation prompt
Build the following focused alternative to Sumora. This is a deliberately limited personal or small-team substitute, not parity with the paid service.

WORKING SLICE
Research a reviewed company target from permitted pages, draft a short evidence-grounded email and pause at a visible approval gate before sending.

SETUP AND ARCHITECTURE
Use TypeScript, Node, better-sqlite3, Playwright and Hono with server-rendered HTML/htmx; no React or ORM. Prerequisites: A reviewed business brief, authorized target URLs, configured model and mail provider credentials and a small local run database. Before integrating anything, record actual versions and permissions, plus model files or provider limits only where used, in the README; make unavailable dependencies visible rather than simulating success.

DOMAIN MODEL AND INVARIANTS
Store BusinessContext, Target, Run, Step, EvidenceQuote, DraftRevision and SendReceipt; approval covers recipient plus exact draft revision and cannot authorize later edits.

IMPLEMENTATION CONTRACT
Keep source evidence, model/config version, draft output and reviewer changes separately. Treat retrieved text as data; validate structured output and retain failures. Never silently send private material to a fallback provider. Provide an input/setup view, the main work view, and a review/export view appropriate to this workflow. Preserve the last saved state if a job or save fails. Include empty, loading, permission-denied, partial and retryable-error states. Log identifiers and error categories without secret values or unnecessary private content.

APP-SPECIFIC BOUNDARY AND RECOVERY
Keep the simple local Hono/htmx architecture and one bounded research loop. Model-provider calls and SMTP leave the host; 'local runner' must not be described as no cloud processing.

ACCEPTANCE SCENARIO
Edit the recipient after approval and simulate a send timeout; invalidate the approval and mark the attempt unknown instead of automatically resending. Also reopen the app after an interrupted operation, confirm the saved record/export remains inspectable, and document the recovery action. These are implementation acceptance requirements, not a claim that this guide has been tested.

DELIVERY
Deliver a runnable repository with migrations or project-format versioning, a non-sensitive example, environment/permission setup, the exact manual acceptance steps, and a backup/export-and-restore walkthrough. Implement the working slice before optional integrations; list any deferred paid-product capabilities honestly. Do not add capabilities outside the working slice just to resemble the original product.

PROJECT RULES FOR AGENTS.md
Keep the domain invariants above executable at the write boundary. Propose scope changes before adding providers or permissions. Never fabricate source evidence, publish results, identity matches or successful delivery. Preserve user originals and require an explicit confirmation for destructive changes or external publication.

## 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.
