# AGENTS.md — Build guide for GetXAPI

## Project scope
Import authorized X exports or responses from an API the user is entitled to access into a local searchable archive of selected handles.

Catalogue verdict: kinda. For personal, read-only scale this is genuinely kinda: twscrape plus a throwaway account gets you tweets from a few handles in a weekend. The gaps are the product: X actively fights automated access, so the DIY version breaks whenever X changes something, burns the accounts it runs on, cannot safely post or DM, has no real-time push, and does not scale. You pay for requests that keep working next week.
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: Python, HTTP parsing, SQLite and optional Playwright for explicitly permitted rendered pages.
- Before starting: A small authorized URL set, reviewed selectors or field schema and a user-approved crawl frequency; no proxy-evasion machinery.

## Stack and architecture
- Python, HTTP parsing, SQLite and optional Playwright for explicitly permitted rendered pages
- Data design: Store SourceAccount, ImportRun, PostID, PostRevision and Observation; distinguish observed engagement counters from timeless attributes and preserve deletion/unavailable markers.
- Setup: A small authorized URL set, reviewed selectors or field schema and a user-approved crawl frequency; no proxy-evasion machinery

## Security and data integrity
- Bound hosts, redirects, page count, body size and timeout. Reject private-network destinations throughout redirects, respect access restrictions and backoff, and distinguish extraction failure from a missing field.
- Replace sacrificial accounts, cookie rotation and fingerprint evasion with explicit authorized access. Read-only archival is the scope; endpoint access, rate limits and redistribution permissions must be checked before implementation.
- 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 SourceAccount, ImportRun, PostID, PostRevision and Observation; distinguish observed engagement counters from timeless attributes and preserve deletion/unavailable markers.
- Project rule — scope and recovery: Replace sacrificial accounts, cookie rotation and fingerprint evasion with explicit authorized access. Read-only archival is the scope; endpoint access, rate limits and redistribution permissions must be checked before implementation.
- Project rule — acceptance: Import the same post twice with newer counters and then an unavailable response; keep one identity with observations and do not replace its last known text with invented content.
- 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: [modern-python](https://github.com/trailofbits/skills/blob/main/plugins/modern-python/skills/modern-python/SKILL.md) — structure the Python worker or explicitly optional read-only utility with pinned dependencies, typed boundaries and clear failure handling. Follow the maintainer's installation instructions and match its requirements to the chosen runtime.
- Recommended skill: [agent-browser](https://github.com/vercel-labs/agent-browser/blob/main/skills/agent-browser/SKILL.md) — inspect the approved browser workflow and reproduce permitted page interactions; the CLI/browser runtime is a separate prerequisite. 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: Import authorized X exports or responses from an API the user is entitled to access into a local searchable archive of selected handles.
- Share a synthetic example export and the acceptance walkthrough; keep real customer, health, financial and source data private: Import the same post twice with newer counters and then an unavailable response; keep one identity with observations and do not replace its last known text with invented content.
- State the limits before asking someone to replace their existing tool: Replace sacrificial accounts, cookie rotation and fingerprint evasion with explicit authorized access. Read-only archival is the scope; endpoint access, rate limits and redistribution permissions must be checked before implementation.

## Engineering roadmap
1. Phase 1 — Pin the working slice and create its example input: Import authorized X exports or responses from an API the user is entitled to access into a local searchable archive of selected handles. Confirm setup: A small authorized URL set, reviewed selectors or field schema and a user-approved crawl frequency; no proxy-evasion machinery.
2. Phase 2 — Implement persistence and write-time invariants before decorating the UI: Store SourceAccount, ImportRun, PostID, PostRevision and Observation; distinguish observed engagement counters from timeless attributes and preserve deletion/unavailable markers.
3. Phase 3 — Connect the working view to real saved state. Bound hosts, redirects, page count, body size and timeout. Reject private-network destinations throughout redirects, respect access restrictions and backoff, and distinguish extraction failure from a missing field.
4. Phase 4 — Expose the app-specific limits and recovery path in context: Replace sacrificial accounts, cookie rotation and fingerprint evasion with explicit authorized access. Read-only archival is the scope; endpoint access, rate limits and redistribution permissions must be checked before implementation.
5. Phase 5 — Walk through this concrete acceptance case and preserve its exported evidence: Import the same post twice with newer counters and then an unavailable response; keep one identity with observations and do not replace its last known text with invented content. Finish the README and backup/restore instructions; report unfinished capabilities explicitly.

## Paid-product capabilities outside this build
- reliability: every X change is your outage until you patch it
- account safety: automation flags and burns the login it runs on
- write actions: posting and DMs from a scraper risk real bans
- real-time push: no webhooks, you poll and you lag
- scale: a few handles works, thousands is a different sport

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

WORKING SLICE
Import authorized X exports or responses from an API the user is entitled to access into a local searchable archive of selected handles.

SETUP AND ARCHITECTURE
Use Python, HTTP parsing, SQLite and optional Playwright for explicitly permitted rendered pages. Prerequisites: A small authorized URL set, reviewed selectors or field schema and a user-approved crawl frequency; no proxy-evasion machinery. 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 SourceAccount, ImportRun, PostID, PostRevision and Observation; distinguish observed engagement counters from timeless attributes and preserve deletion/unavailable markers.

IMPLEMENTATION CONTRACT
Bound hosts, redirects, page count, body size and timeout. Reject private-network destinations throughout redirects, respect access restrictions and backoff, and distinguish extraction failure from a missing field. 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
Replace sacrificial accounts, cookie rotation and fingerprint evasion with explicit authorized access. Read-only archival is the scope; endpoint access, rate limits and redistribution permissions must be checked before implementation.

ACCEPTANCE SCENARIO
Import the same post twice with newer counters and then an unavailable response; keep one identity with observations and do not replace its last known text with invented content. 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.