review-project-setup
Skill2 starsChanged 35 days agoMITView on GitHub
Creates the review project folder, interviews the user for topic, field, review type, audience, and timeline, and writes project.yaml plus LOG.md. Trigger on "start a new review on X", "new literature review", or "set up the review project". Do not use it to choose the final angle, write a search, or draft the manuscript.
In this repository20 other files it gives its agents.
- AGENTS.mdAGENTS.md
- CLAUDE.mdCLAUDE.md
- .cursor/rules/literature-review.mdcCursor rule
- exemplar-review-analysisSkill
- figure-permissionsSkill
- journal-selectionSkill
- literature-screeningSkill
- manuscript-polishingSkill
- paper-deep-readingSkill
- reviewer-responseSkill
- review-figures-and-tablesSkill
- review-orchestratorSkill
- review-outline-builderSkill
- review-scoping-and-gapsSkill
- review-section-drafterSkill
- review-writingSkill
- search-export-and-dedupSkill
- search-strategy-builderSkill
- submission-packageSkill
- zotero-library-syncSkill
The file
We split this skill into the rules it gives an agent
11 rules. About 0 are common, 3 are distinctive, and 8 are very specific to this project.
≈0
Common · estimate
Many files like this have a rule of this kind.
≈3
Distinctive · estimate
This author's own choices. Worth a look.
8
Very specific
Tied to their project's names, files or tools. Probably skip.
- Common
- Distinctive
- Very specific
- Very specific: line 33
Ask, in one message, for: working title.
- Very specific: line 39
Create every directory below, plus 04-library/uploads/.
- Very specific: line 64
Write LOG.md exactly as:
- Very specific: line 75
Do not set topic_lock. The working title is not the locked angle.
- Very specific: line 89
Every gate key exists and is YAML false, not the string "false".
- Distinctive: line 93
No search string, hit count, or citation appears in the yaml.
- Distinctive: line 98
Do not invent a journal, an impact factor, or a sample of papers.
- Distinctive: line 99
Do not ask for, type, or store a password, captcha, or second factor.
- Very specific: line 100
Do not change narrative_core_cap after the project file is confirmed.
- Very specific: line 101
Do not delete a project that already has a LOG.md with decisions.
- Very specific: line 102
Write only inside <project>/.
≈ “Common” is an estimate: at least 1 in 5 of the 372,429 skill 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.
Files
Review project setup
Opening
On first use in a project, say this verbatim:
I am review project setup. I create the project folder and project.yaml from your answers. You do not need a library login: I search free databases and download open-access PDFs myself, and I only ask you for the few essential papers I cannot get.
When to use
No project.yaml exists yet, or the user asked to start a review. This skill builds the empty folder layout and records the interview. It does not lock the topic.
Inputs (paths) / Preconditions
- A parent directory the user names. Create
<project>/inside it. Do not scatter files outside that folder. - The user's answers. If an answer is missing, ask once, then stop. Do not fill the gap from general knowledge.
- Copy the key names from
references/project.yaml.example.
Procedure (numbered steps)
- Do not ask about library logins. The default setting is
download_access: open_access: the agent searches the free APIs (OpenAlex, Europe PMC, PubMed, Semantic Scholar, and arXiv; Crossref on request; bioRxiv and medRxiv preprints come in through Europe PMC) and downloads open-access PDFs itself. This needs no browser homepage and no gate. - Optional extras (only if the user brings them up or asks for Web of Science, Scopus, or their Zotero library): set
use_subscription_databases: trueoruse_zotero: trueas requested. For subscription databases, open https://www.webofscience.com/ in the browser and let the user sign in (never enter a password, captcha, or second factor yourself). Then ask them to reply withI have confirmed institutional login(setsdownload_access: institutional) orI have no download permission on this computer(setsdownload_access: unavailable). Verify the reply withpython3 <suite>/skills/review-orchestrator/scripts/check_gate_phrase.py --gate institutional_access --reply "<user line>"(or--gate no_download_permission). On a match, setgates.institutional_accesstotrue. If the user never sends the sentence, keepopen_accessand move on; no later step waits for this gate. - Ask, in one message, for: working title; field; review type (
narrative,systematic,scoping, orumbrella); audience (who will read it); timeline; target journal orundecided; whether PubMed will be searched; and the project directory path. - Restate the four review types in one line each before accepting the answer if the user is unsure:
- narrative: a scoped argument, not an exhaustive search; the reading set is capped by
narrative_core_cap - systematic: a pre-specified question, search, and eligibility screen (PRISMA 2020)
- scoping: how much and what kind of evidence exists (JBI PCC; report with PRISMA-ScR)
- umbrella: the included records are reviews, not primary studies
- narrative: a scoped argument, not an exhaustive search; the reading set is capped by
- Create every directory below, plus
04-library/uploads/. CreateLOG.mdandproject.yaml. Do not createevidence/evidence_table.csvhere;paper-deep-readingwrites it with the header inshared/evidence_table_schema.md.
<project>/
project.yaml
LOG.md
00-scope/
01-search/
02-records/
03-screening/
04-library/
05-reading/
evidence/
06-exemplars/
07-outline/
08-figures/
09-draft/
10-polish/
11-journal/
12-permissions/
13-submission/
14-revision/- Write
project.yamlfromreferences/project.yaml.example. Setnarrative_core_capto500unless the user already typed a different positive integer in this interview. Do not change that number later. Setsearch_pubmedfrom their answer. Setdownload_access: open_access,use_subscription_databases: false, anduse_zotero: falseunless step 2 changed them. Set every gate to booleanfalse, exceptinstitutional_accesswhen step 2 passed. Use today's date forcreatedandupdated. Setlanguage: en. Quote any string that contains a colon. - Write
LOG.mdexactly as:
# Decision log
Append-only. One decision per line. Do not delete lines.
YYYY-MM-DD | review-project-setup | project initialized | agent- Show the user the yaml. Ask: "Confirm this project file? Reply yes or no." On yes, append
YYYY-MM-DD | review-project-setup | project_confirmed | human. On no, edit only the fields they correct, exceptnarrative_core_capand the gate keys, and ask again. - Do not set
topic_lock. The working title is not the locked angle.
Human gate(s)
None is required. institutional_access is an optional extra, used only when the user wants subscription databases or institutional downloads (sentences in shared/gates.md). A checker script does not replace the user's sentence. Confirming the yaml is a checkpoint, not a lock. Topic lock belongs to review-scoping-and-gaps.
Outputs (exact paths + formats)
<project>/project.yaml— keys inreferences/project.yaml.example<project>/LOG.md— header plus the lines above- The fourteen numbered directories, plus
evidence/
Quality checklist
- Every gate key exists and is YAML
false, not the string"false".institutional_accessistrueonly after the optional exact sentence. narrative_core_capis a positive integer,500unless the user set it in the interview.download_accessisopen_accessunless the optional gate setinstitutionalorunavailable.review_typeis one of the four allowed words.- No search string, hit count, or citation appears in the yaml.
LOG.mdhas the initialized line and, after a yes, the confirmed line.
Guardrails
- Do not invent a journal, an impact factor, or a sample of papers.
- Do not ask for, type, or store a password, captcha, or second factor.
- Do not change
narrative_core_capafter the project file is confirmed. - Do not delete a project that already has a
LOG.mdwith decisions. Ask the user before writing overproject.yaml. - Write only inside
<project>/.
Next step
review-scoping-and-gaps, after project_confirmed is in the log. Until then, stay here.
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
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.

