AlexandrAI AGENTS.md
agents-md

Gumroad Product Schema Agent Guide

Project-specific AGENTS.md guidance for the Gumroad product.json schema, required fields, template body contracts, source notes, support fields, and downstream render expectations.

AGENTS.md

Guidance for coding agents working on the Gumroad product.json schema.

Project Overview

products/<slug>/product.json is the source of truth for a Gumroad product run. The schema requires commercial positioning, Gumroad page copy, PDF sections, editable templates, policy fields, image prompts, and page design notes. Scripts render the product directly from this file.

Source Files

  • schemas/product.schema.json defines required product fields.
  • agents/product-planner.md creates the first schema-ready product plan.
  • agents/content-producer.md fills sections and templates.
  • scripts/product_artifacts.py loads, normalizes, renders, and QA-checks product.json.
  • tests/test_product_artifacts_content_quality.py verifies schema-adjacent quality gates.

Setup Commands

bashUV_LINK_MODE=copy UV_PROJECT_ENVIRONMENT="$HOME/.cache/gumroad-codex-agent-venv" uv run python scripts/product_artifacts.py render products/<slug>/product.json
UV_LINK_MODE=copy UV_PROJECT_ENVIRONMENT="$HOME/.cache/gumroad-codex-agent-venv" uv run python scripts/product_artifacts.py qa products/<slug>

Required Fields

product.json must include slug, title, subtitle, audience, promise, summary, price_cents, currency, taxonomy_id, taxonomy_path, tags, description_html, sections, templates, refund_policy, disclaimer, support, originality_notes, cover_prompt, cover_alt_text, and page_design_notes.

Change Rules For Agents

  • Keep slug stable, lowercase, and hyphenated.
  • Keep currency as usd unless the owner explicitly changes store strategy.
  • Use a real Gumroad taxonomy id and taxonomy path; do not fall back to Other without explicit owner direction.
  • Keep description_html simple and aligned with actual files.
  • Sections must be substantial enough to render a useful PDF guide.
  • Templates must include filename, title, and body.
  • JSON templates must contain valid JSON.
  • Source notes are required when factual, platform, market, or web-derived claims are used.
  • Disclaimer must exclude legal, financial, medical, tax, and guaranteed business advice.
  • Support and refund_policy must be realistic and scoped.

Verification

Run render and QA. QA catches missing fields, bad currency, bad taxonomy, too few tags, thin sections, thin templates, missing source notes, weak disclaimer, bad artifacts, and missing meeting trace.

Security Notes

Do not store credentials, private account ids, buyer data, hidden webhook URLs, private endpoints, or absolute local paths in product.json or template bodies.

PR Checklist

  • All required fields are present.
  • Product claims map to real sections and templates.
  • Source notes and disclaimer are present.
  • Template filenames are safe.
  • Render and QA pass.