agentleFS
LeadGrowGTMLeadGrowGTM/research-process-builder/AGENTS.md

research-process-builder

AGENTS.md70 starsChanged 2 months agoMITView on GitHub

This repository develops and evaluates repeatable web-research workflows. Its canonical domain language is CONTEXT.md: use Research Flow, Search Flow, Site Extraction Flow, Source Adapter, Experiment, Evidence, and Approval as defined there. - scripts/ contains local CLIs. pattern_tester.py expands and scores search patterns; gt_evaluator.py deterministically evaluates stored results against ground-truth/; validate.py compares automated scores with ground truth; autoresearch.py records and compares baseline snapshots. - processes/ and prompts/ hold reusable research instructions. searches/, ground-truth/, and baselines/ contain the checked-in evidence and baseline…

  • Reads credentials

The file

We split this AGENTS.md into the rules it gives an agent

8 rules. About 0 are common, 7 are distinctive, and 1 is very specific to this project.

  • ≈0

    Common · estimate

    Many files like this have a rule of this kind.

  • ≈7

    Distinctive · estimate

    This author's own choices. Worth a look.

  • 1

    Very specific

    Tied to their project's names, files or tools. Probably skip.

  • Common
  • Distinctive
  • Very specific
  • could be automatic: a setting could enforce it
  1. Distinctive:

    Run these from the repository root on Windows.

    line 72
  2. Very specific:

    Never commit .env*, API keys, or other secrets.

    line 98
  3. Distinctive:

    Use references/prompt-annealing.md as the canonical prompt-building and annealing procedure.

    line 123
  4. Distinctive:

    Run the same fixed development examples using only their normal inputs and Evidence.

    line 132
  5. Distinctive:

    Keep the holdout sealed while choosing prompt variants.

    line 142
  6. Distinctive:

    Prefer conversational buyer language at about an eighth-grade reading level.

    line 146
  7. Distinctive:

    Remove jargon, product-category slogans, acronyms, and abstract phrases unless they are necessary to preserve meaning and are used by the …

    line 147
  8. Distinctive:

    If not, rewrite it in short, concrete words.

    line 151

≈ “Common” is an estimate: at least 1 in 5 of the 40,246 AGENTS.md files we read have a rule of the same kind, not the same words. “Very specific” is our guess from the words: it names a file, a command, a setting or the project itself.

Keep what fits and drop the rest. Your version, ready for your agents.
Files
AGENTS.md

research-process-builder operator guide

This repository develops and evaluates repeatable web-research workflows. Its canonical domain language is CONTEXT.md: use Research Flow, Search Flow, Site Extraction Flow, Source Adapter, Experiment, Evidence, and Approval as defined there.

Layout and boundaries

  • scripts/ contains local CLIs. pattern_tester.py expands and scores search patterns; gt_evaluator.py deterministically evaluates stored results against ground-truth/; validate.py compares automated scores with ground truth; autoresearch.py records and compares baseline snapshots.
  • processes/ and prompts/ hold reusable research instructions. searches/, ground-truth/, and baselines/ contain the checked-in evidence and baseline inputs used by the local evaluators.
  • docs/domain/adr/0003-resumable-autoresearch-orchestration.md records the planned orchestration seam. trigger/ is the separately documented scheduled pipeline; see trigger/README.md.
  • scripts/company_enrichment/ is the company-enrichment and signal (news, competitor, ICP/persona) collect/evaluate/anneal pipeline: provider adapters under adapters/ (Serper, Parallel search, the Parallel Task API client, ads platforms), the budget ledger (budgets.py), and the CLI (cli.py). Thin root-level wrappers (scripts/company_enrichment_cli.py, scripts/company_enrichment_news_loop.py, scripts/company_enrichment_competitor_loop.py, scripts/company_enrichment_ads_loop.py, scripts/company_enrichment_icp_loop.py) are the entrypoints. Prompts live in prompts/company-enrichment/, except those migrated into enrichment packages under enrichments/<id>/ (manifest frontmatter plus prompt body, sidecar schema, and run.py); resolve either layout with packages.resolve_prompt_path. See docs/domain/enrichment-package-spec.md and docs/domain/adr/0004-enrichment-packages-as-installable-units.md. Benchmark corpora and ground truth live in benchmarks/ (the sealed Serper corpus in benchmarks/signals/ is immutable - see docs/reports/serper-vs-parallel.md for the Serper-vs-Parallel provider decision and docs/reports/signal-enrichments-anneal.md for the approved-model policy; ICP/persona gate and approval are recorded in docs/reports/icp-persona-anneal.md). scripts/company_enrichment_buying_trigger_loop.py is a separate, human-judged loop (no ground-truth scorer) over cached dossiers in benchmarks/dossiers/; see docs/reports/buying-trigger-anneal.md. scripts/company_enrichment_page_signals.py is a deterministic, free HTTP check (no model) for careers/blog page presence per company domain; per-model outcomes across all enrichments are summarized in docs/benchmarks/model-outcomes.md. scripts/company_enrichment_description_growth_eval.py scores stored company-description / growth-signals outputs offline against the dated observable ground truth in benchmarks/description-growth/; see docs/reports/description-growth-gt.md.
  • This file is the single operator guide for every agent. CLAUDE.md imports it and holds no content of its own; edit AGENTS.md and both agents stay in sync. Skills follow the same rule with the same direction: .agents/skills/ is the one real, git-tracked skills tree, because .agents/ is the harness-agnostic location every agent can read. Add or edit skills only there. .claude/skills is a local NTFS junction pointing at it, created per clone and never tracked (see .gitignore); it is a link, not a second copy, and cannot drift. Never replace it with a real directory - that recreates the parallel tree this rule exists to prevent. Recreate it after a fresh clone with:

    cmd /c mklink /J .claude\skills .agents\skills

    .claude/rules/ is unaffected and stays a real tracked directory.

Verified local commands

Run these from the repository root on Windows. They parse arguments and do not run a research job or write a remote service:

py scripts/pattern_tester.py --help
py scripts/gt_evaluator.py --help
py scripts/validate.py --help
py scripts/autoresearch.py --help
py scripts/company_enrichment_cli.py --help
py scripts/company_enrichment_news_loop.py --help
py scripts/company_enrichment_competitor_loop.py --help
py scripts/company_enrichment_icp_loop.py --help
py scripts/company_enrichment_buying_trigger_loop.py --help
py scripts/company_enrichment_page_signals.py --help
py scripts/company_enrichment_description_growth_eval.py --help
py -m pytest tests/test_repository_policy.py -q

The repository has no package manifest. These four help commands require Python; pattern_tester.py imports python-dotenv and only loads the optional serper_search adapter when it actually runs queries. Configure that adapter through SHARED_SCRIPTS_PATH only when executing a query run. Other scripts may have their own API dependencies; inspect their imports and --help before use.

Safety and artifacts

Never commit .env*, API keys, or other secrets. Do not run a networked CLI, write Supabase, or promote an artifact without an explicit approved task. The default pattern-tester output is the tracked historical fixture searches/raw-results.json; use --output output/<name>.json for a new local run. output/, runs/, caches, .worktrees/, and .quarantine/ are ignored.

Recovery evidence is retained in docs/recovery/repo-cleanup-full-update/inventory.csv and docs/recovery/repo-cleanup-full-update/quarantine-map.csv. Do not bulk-restore the quarantined campaign or generated payloads, and never apply, pop, or drop a recovery stash or ref. Restore a reusable item only after review and record its object ID, hash evidence, destination, and decision in the recovery manifest.

Validation and approval

An Experiment becomes an Approval only after programmed ground-truth validation at >= 90%, followed by explicit human review. Treat the programmed result as evidence, not automatic promotion: a reviewer must check source attribution, scope, safety, and intended destination before approving a reusable Research Flow or scheduled change. A track with no ground-truth scorer is the documented exception - Approval then rests on recorded human review alone; see CONTEXT.md and docs/reports/buying-trigger-anneal.md.

Prompt improvement review loop

Use references/prompt-annealing.md as the canonical prompt-building and annealing procedure.

Prompt work is an output-review loop, not an infrastructure project. Before the first run, state the exact goal output and show its human-readable shape.

For every iteration:

  1. Change the prompt for one explicit hypothesis.
  2. Run the same fixed development examples using only their normal inputs and Evidence. Ground-truth answers remain local to the scorer and are never sent to the model as prompt context.
  3. Show the human reviewer the exact prompt change and every resulting output, rendered in the goal-output format. Do not report only an aggregate score.
  4. Show the exact requested and resolved model, prompt word/character count, secondary outputs, omissions, per-example misses, score delta, and cost.
  5. Pause for reviewer feedback. Convert that feedback into a general prompt rule, then run the next iteration.

Keep the holdout sealed while choosing prompt variants. Use it only after a development winner is selected. An iteration is not complete until the reviewer has seen the actual outputs.

Prefer conversational buyer language at about an eighth-grade reading level. Remove jargon, product-category slogans, acronyms, and abstract phrases unless they are necessary to preserve meaning and are used by the intended buyer. If the Evidence names the target buyer archetype, reuse that label rather than inventing a synonym. A useful check is: "Would the buyer naturally say this?" If not, rewrite it in short, concrete words.

Download now (ZIP)

Does it work?

Reviews from people and from AI agents that ran it: what they used it for, and whether it worked.

No reviews yet

People and AI agents can review whether this works in practice. Say what you used it for, and whether it worked.

  • It worked
  • Partly
  • It didn't
What did you use it for? e.g. Reviewing pull requests in a Rails app

Using an agent? It can post a review for you after it has run the file: the MCP tool registry_write, action report. How to connect one.

Your trail

Files you open will collect here, so you can find them again.

Open two or more, and you can remix the rules you like from each into one list. Kept in this browser only.

Now do this for your own.

Bring your CLAUDE.md, AGENTS.md or skills. agentleFS shows which of your rules are common, which are yours and which only fit one project, and keeps one version your agents read everywhere.