# AGENTS.md — Build guide for StocksBrew ## Project scope Fetch permitted end-of-day market data and SEC filings for a small watchlist, show the source/time and evaluate user-defined threshold alerts. Keep transparent observations separate from investment recommendations. Catalogue verdict: kinda. A personal stock-research cockpit is very buildable, but StocksBrew's useful current calls depend on continuously maintained market, filings, news, and alert pipelines. A DIY version can make its evidence and rules explicit; it will not inherit the service's coverage, refresh reliability, or editorial judgment. 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 - A supported Node release, a writable local data directory and a separate backup location. Bind to localhost; remote use requires authentication and HTTPS first. - Implementation components: Node.js, TypeScript and Express with server-rendered HTML and small browser modules. SQLite through better-sqlite3 with migrations, prepared statements and a single background worker. - Scope boundary: Real-time exchange feeds, suitability advice and guaranteed data coverage are outside scope. ## Stack and architecture - Node.js, TypeScript and Express with server-rendered HTML and small browser modules. - SQLite through better-sqlite3 with migrations, prepared statements and a single background worker. - Domain model: watchlist symbols, source-dated prices, SEC filing references, alert rules and delivery checkpoints ## Security and data integrity - Reject unexpected origins and unbounded request bodies even on localhost. Keep credentials outside the database export and redact sensitive text from logs. - Correctness boundary: Stale or missing prices cannot trigger a confident current-price alert; ticker changes and splits require explicit treatment and no return prediction is invented. - Use short SQLite transactions and persist job state before starting work. Give retries stable operation IDs; report incomplete or unknown results instead of silently repeating them. - Use a consistent SQLite backup and an attachment manifest. Export portable JSON/CSV, then restore to a new directory without overwriting the original data. ## Agent implementation rules - Project rule — data model: watchlist symbols, source-dated prices, SEC filing references, alert rules and delivery checkpoints - Project rule — preserve this invariant: Stale or missing prices cannot trigger a confident current-price alert; ticker changes and splits require explicit treatment and no return prediction is invented. - Project rule — acceptance evidence: A data outage labels the last price stale and suppresses new threshold alerts; replaying a filing does not send another notification. ## Optional agent skills and references - Optional external skill: [web-design-guidelines](https://github.com/vercel-labs/agent-skills/blob/main/skills/web-design-guidelines/SKILL.md) — Review web interfaces for accessibility, keyboard focus, forms, navigation and interaction quality. Review its instructions and compatibility before use; it does not grant deployment, data-access or publication permission. - Optional external skill: [sharp-edges](https://github.com/trailofbits/skills/blob/main/plugins/sharp-edges/skills/sharp-edges/SKILL.md) — Review security-sensitive APIs and configuration for dangerous defaults and easy-to-misuse interfaces. Review its instructions and compatibility before use; it does not grant deployment, data-access or publication permission. 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 the actual StocksBrew-inspired workflow with owned or clearly labeled sample data: Fetch permitted end-of-day market data and SEC filings for a small watchlist, show the source/time and evaluate user-defined threshold alerts. Keep transparent observations separate from investment recommendations. - Publish a reproducible walkthrough with this observable result: A data outage labels the last price stale and suppresses new threshold alerts; replaying a filing does not send another notification. - Explain who can operate this scoped tool, its setup and ongoing costs, and these remaining product gaps: Real-time exchange feeds, suitability advice and guaranteed data coverage are outside scope. Avoid guaranteed savings, performance scores or implied endorsement. ## Engineering roadmap 1. Phase 1 — Scope and fixtures. Implement this bounded workflow: Fetch permitted end-of-day market data and SEC filings for a small watchlist, show the source/time and evaluate user-defined threshold alerts. Keep transparent observations separate from investment recommendations. Record prerequisites, select representative user-owned fixtures and document the unsupported features: Real-time exchange feeds, suitability advice and guaranteed data coverage are outside scope. 2. Phase 2 — Durable model. Model watchlist symbols, source-dated prices, SEC filing references, alert rules and delivery checkpoints Add migrations or a versioned document format, explicit validation, stable IDs and a visible import-error report. Preserve this rule: Stale or missing prices cannot trigger a confident current-price alert; ticker changes and splits require explicit treatment and no return prediction is invented. 3. Phase 3 — Complete the first useful path. Implement the workflow's input, review and output interface, with clear controls and explicit empty/error states. Use short SQLite transactions and persist job state before starting work. Give retries stable operation IDs; report incomplete or unknown results instead of silently repeating them. 4. Phase 4 — Permissions and integration failure. Reject unexpected origins and unbounded request bodies even on localhost. Keep credentials outside the database export and redact sensitive text from logs. Request integration credentials and permissions only for the enabled feature; show a disconnected state instead of mock results. 5. Phase 5 — Portable handoff. Use a consistent SQLite backup and an attachment manifest. Export portable JSON/CSV, then restore to a new directory without overwriting the original data. Include setup, operating limits, fixture walkthrough and shutdown/restart instructions in the README. 6. Phase 6 — Acceptance scenarios. A data outage labels the last price stale and suppresses new threshold alerts; replaying a filing does not send another notification. Repeat the workflow after restart and with a denied permission or unavailable dependency; show recoverable failure rather than a success placeholder. ## Paid-product capabilities outside this build - maintained stock coverage and editorial calls - intraday data quality and provider reliability - managed earnings and price alert delivery - the product's target-price methodology - AI-agent API access ## Implementation prompt WORKING SLICE Fetch permitted end-of-day market data and SEC filings for a small watchlist, show the source/time and evaluate user-defined threshold alerts. Keep transparent observations separate from investment recommendations. Build this scoped StocksBrew-inspired workflow with a documented data model and visible failure states. Architecture - Node.js, TypeScript and Express with server-rendered HTML and small browser modules. - SQLite through better-sqlite3 with migrations, prepared statements and a single background worker. Prerequisites and limits A supported Node release, a writable local data directory and a separate backup location. Bind to localhost; remote use requires authentication and HTTPS first. Outside this release: Real-time exchange feeds, suitability advice and guaranteed data coverage are outside scope. Data model and correctness watchlist symbols, source-dated prices, SEC filing references, alert rules and delivery checkpoints Invariant: Stale or missing prices cannot trigger a confident current-price alert; ticker changes and splits require explicit treatment and no return prediction is invented. Use short SQLite transactions and persist job state before starting work. Give retries stable operation IDs; report incomplete or unknown results instead of silently repeating them. Security and privacy Reject unexpected origins and unbounded request bodies even on localhost. Keep credentials outside the database export and redact sensitive text from logs. Recovery and export Use a consistent SQLite backup and an attachment manifest. Export portable JSON/CSV, then restore to a new directory without overwriting the original data. Implementation order 1. Phase 1 — Scope and fixtures. Implement this bounded workflow: Fetch permitted end-of-day market data and SEC filings for a small watchlist, show the source/time and evaluate user-defined threshold alerts. Keep transparent observations separate from investment recommendations. Record prerequisites, select representative user-owned fixtures and document the unsupported features: Real-time exchange feeds, suitability advice and guaranteed data coverage are outside scope. 2. Phase 2 — Durable model. Model watchlist symbols, source-dated prices, SEC filing references, alert rules and delivery checkpoints Add migrations or a versioned document format, explicit validation, stable IDs and a visible import-error report. Preserve this rule: Stale or missing prices cannot trigger a confident current-price alert; ticker changes and splits require explicit treatment and no return prediction is invented. 3. Phase 3 — Complete the first useful path. Implement the workflow's input, review and output interface, with clear controls and explicit empty/error states. Use short SQLite transactions and persist job state before starting work. Give retries stable operation IDs; report incomplete or unknown results instead of silently repeating them. 4. Phase 4 — Permissions and integration failure. Reject unexpected origins and unbounded request bodies even on localhost. Keep credentials outside the database export and redact sensitive text from logs. Request integration credentials and permissions only for the enabled feature; show a disconnected state instead of mock results. 5. Phase 5 — Portable handoff. Use a consistent SQLite backup and an attachment manifest. Export portable JSON/CSV, then restore to a new directory without overwriting the original data. Include setup, operating limits, fixture walkthrough and shutdown/restart instructions in the README. 6. Phase 6 — Acceptance scenarios. A data outage labels the last price stale and suppresses new threshold alerts; replaying a filing does not send another notification. Repeat the workflow after restart and with a denied permission or unavailable dependency; show recoverable failure rather than a success placeholder. Acceptance A data outage labels the last price stale and suppresses new threshold alerts; replaying a filing does not send another notification. Use real source data or clearly labeled fixtures. Explain unsupported input and provider failures; do not fabricate analytics, delivery receipts, accuracy claims or security guarantees. Optional agent guidance Optional external skill: [web-design-guidelines](https://github.com/vercel-labs/agent-skills/blob/main/skills/web-design-guidelines/SKILL.md) — Review web interfaces for accessibility, keyboard focus, forms, navigation and interaction quality. Review its instructions and compatibility before use; it does not grant deployment, data-access or publication permission. Optional external skill: [sharp-edges](https://github.com/trailofbits/skills/blob/main/plugins/sharp-edges/skills/sharp-edges/SKILL.md) — Review security-sensitive APIs and configuration for dangerous defaults and easy-to-misuse interfaces. Review its instructions and compatibility before use; it does not grant deployment, data-access or publication permission. Project rule — data model: watchlist symbols, source-dated prices, SEC filing references, alert rules and delivery checkpoints Project rule — preserve this invariant: Stale or missing prices cannot trigger a confident current-price alert; ticker changes and splits require explicit treatment and no return prediction is invented. Project rule — acceptance evidence: A data outage labels the last price stale and suppresses new threshold alerts; replaying a filing does not send another notification. ## 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.