llm-checklist
Skill17 starsChanged 3 months agoMITView on GitHub
Logs LLM-as-research-instrument use (model version, access mode, config, prompts) to a ledger as it happens and compiles the 14-item GUIDE-LLM reporting checklist (Feuerriegel et al. 2026) for the methods/SI. Use whenever an LLM is integral to the design — annotation, classification, simulated participants, stimulus generation, data extraction, participant-facing chatbots — even if the user only mentions having used ChatGPT, Claude, Gemini, or an open model to code or label data; not for editorial drafting. Run before submission to flag missing items.
In this repository38 other files it gives its agents.
- abstract-shotgunSkill
- analyzeSkill
- archiveSkill
- carefulSkill
- coauthor-reviewSkill
- codebookSkill
- cover-letterSkill
- data-acquireSkill
- data-cleanSkill
- design-researchSkill
- draft-sectionSkill
- freezeSkill
- guardSkill
- hypothesis-designSkill
- idea-shotgunSkill
- identification-reviewSkill
- journal-fitSkill
- learnSkill
- lit-mapSkill
- mstack-initSkill
- mstack-upgradeSkill
- paper-statusSkill
- pdf-ingestSkill
- power-analysisSkill
- preregisterSkill
- r-and-rSkill
- referee-mockSkill
- research-questionSkill
- results-auditSkill
- retroSkill
- robustnessSkill
- scope-challengeSkill
- submission-packSkill
- survey-buildSkill
- theory-buildSkill
- title-shotgunSkill
- unfreezeSkill
- vizSkill
The file
We split this skill into the rules it gives an agent
5 rules. About 0 are common, 1 is distinctive, and 4 are very specific to this project.
≈0
Common · estimate
Many files like this have a rule of this kind.
≈1
Distinctive · estimate
This author's own choices. Worth a look.
4
Very specific
Tied to their project's names, files or tools. Probably skip.
- Common
- Distinctive
- Very specific
- Very specific: line 69
Create the ledger with a _meta header if absent (competing interests from .mstack/config.yaml authors / funding if available.
- Distinctive: line 72
Write the normalized object as one line.
- Very specific: line 73
If prompt_user_ref / code_ref point at files that do not exist yet, remind the user to save the verbatim prompt and the call script there: …
- Very specific: line 83
Read the ledger and .mstack/config.yaml.
- Very specific: line 84
Read references/guide-llm-items.md in this skill's folder for the verbatim 14 items and the LaTeX skeleton.
≈ “Common” is an estimate: at least 1 in 5 of the 350,495 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
/mstack:llm-checklist
Stage: cross-cutting (build → submit) · Voice: reporting-clerk
Implements GUIDE-LLM, the consensus reporting checklist for large language models in behavioural and social science (Feuerriegel, S. et al., Nature Human Behaviour, 2026, https://doi.org/10.1038/s41562-026-02492-7). Two jobs: log LLM use as it happens, and compile the filled checklist for the paper.
Log the first time an LLM touches the research and every time the model, version, prompt, or configuration changes, not at write-up: the checklist wants the exact version (often dated, like gpt-4o-2024-11-20), access mode, and configuration, and these change or are discontinued without notice, so the only reliable record is the one captured when the calls were run.
Integral vs. editorial
GUIDE-LLM covers LLM use that is integral to the research design, not minor editorial help.
- Log: text annotation, classification, sentiment / stance / emotion coding, moral-language detection; simulated participants, in-silico experiments, synthetic respondents; generating or selecting stimuli, vignettes, or treatments; extracting variables from documents that enter the analysis; a participant-facing chatbot (intervention, teaching, persuasion). Claude via MStack coding study data or simulating respondents counts.
- Do not log here (disclose per the journal's AI-use policy instead): drafting prose, formatting tables, debugging code, brainstorming, including Claude / MStack as a writing aid. Drafting the discussion section is not an instrument.
- In doubt, log it: over-disclosure costs a table row, under-disclosure costs reproducibility.
Subcommands ($ARGUMENTS)
log [free text or details]— append or update one LLM task; free-form is fine, the skill normalizes it and asks for missing checklist-critical fields.status— per-task coverage of the 14 required items, plus a scan of the codebase for LLM calls no task references.report(default) — compile the checklist from the ledger to.mstack/llm-checklist.md.latex— also emit a Supplementary-Information block topaper/sections/llm-checklist.tex.
The ledger
.mstack/llm-usage.jsonl: append-only, one JSON object per line, one LLM task per line (a distinct model used for a distinct purpose; the paper reports each separately, so one task = one line = one checklist block). Line 1 is a _meta header (competing interests, GUIDE-LLM citation). Lines tagged "_example": true are illustrative and ignored by status / report. Fields map 1:1 to checklist items:
{
"id": "short-stable-handle", "date_logged": "YYYY-MM-DD",
"purpose": "", // A.1
"automation": "", // A.2 human-in-the-loop | fully-automated (+ audit rate)
"model": {"name": "", "provider": "", "size": "", // B.1
"version_or_id": "", "access_date": "", "source_url": ""},
"access_mode": "", "context_mode": "", // B.2 API | web | local; chat | separate-calls
"config": {"temperature": null, "max_tokens": null, "seed": null, "n_runs": null, "other": ""}, // B.3
"customization": "", // B.4 none | fine-tuned | RAG | tools/function-calling | ...
"persistent_memory": false, // B.5
"prompt_user_ref": "", "prompt_system_ref": "", // C.1, C.2 paths to verbatim prompt files
"data_sensitivity": "", // D.1
"human_validation": "", "post_processing": "", // E.1, E.2
"code_ref": "", // F.1 path to the script / notebook making the calls
"opt": {"llm_choice_justification": "", "prompt_design_rationale": "", "cross_model_comparison": "",
"training_data_leakage": "", "bias_assessment": "", "transcripts_ref": "",
"ethical_implications": "", "compute_use": ""},
"notes": ""
}Prompts live in files (e.g. code/llm/prompts/*.txt) referenced by path; never paraphrase a prompt into the ledger or inline it as a giant JSON string. For an agentic system with no single verbatim prompt, point prompt_user_ref at the source or config that defines the interaction logic and say so in notes (the paper permits "the most complete documentation feasible").
Procedure
log
- Create the ledger with a
_metaheader if absent (competing interests from.mstack/config.yamlauthors / funding if available; otherwise blank and flagged). - Get today's date (
date +%Y-%m-%d); parse the user's text into the schema. Anidthat already exists means update that task in place (re-read and rewrite the file); otherwise mint a shortidfrom purpose + date. - Fill what you can, then ask only for the checklist-critical fields still empty: exact
model.version_or_id(refuse a bare brand like "ChatGPT" or "GPT-4");access_mode+context_mode;config.temperatureandn_runs(temperature drives reproducibility; if the model exposes none, record that);prompt_user_refas a path, not a paraphrase;human_validationplan or result. Never block onopt.*. - Write the normalized object as one line; echo it back.
- If
prompt_user_ref/code_refpoint at files that do not exist yet, remind the user to save the verbatim prompt and the call script there: C.1 and F.1 need them and/mstack:archivecollects them.
status
- For each non-
_meta, non-_exampletask print a 14-row check (✅ filled / ⚠️ missing, item code + name), grouped byid. - Grep the project (
code/,*.py,*.R,*.ipynb,*.qmd) for call sites (openai,anthropic,chat.completions,client.messages.create,litellm,ollama,transformers,huggingface,gemini,vertexai,together,groq); list any file that calls an LLM but is not referenced by some task'scode_refand warn it may need a ledger entry. - One-line verdict:
N tasks, M required items missing across themplus the exact list to fix.
report (and latex)
- Read the ledger and
.mstack/config.yaml; skip_meta/_examplelines. - Read
references/guide-llm-items.mdin this skill's folder for the verbatim 14 items and the LaTeX skeleton. - One block per task: the full GUIDE-LLM table filled from the task fields, with every empty required field rendered as
⚠️ MISSING — <what to capture>so the gap is visible in the draft; a separate "Optional (GUIDE-LLM online)" subsection fromopt.*, omitting blanks (no ⚠️ there). - G.1 (competing interests / funding) once, from
_meta.competing_interestscross-checked against config; flag if blank, it is required. - Citation footer with the template link (https://osf.io/mv63j/). Write
.mstack/llm-checklist.mdand print the missing-item summary. - For
latex(or on offer), also writepaper/sections/llm-checklist.tex(adescription/longtableblock from the skeleton) and tell the user to\inputit.
Outputs
.mstack/llm-usage.jsonl— the ledger, created on firstlog..mstack/llm-checklist.md— the compiled checklist, one block per task, missing items flagged.paper/sections/llm-checklist.tex— on request, an SI-ready block.
Anti-patterns
- Bare model names. "We used ChatGPT / GPT-4" hides version, configuration, and access mode that change results; demand the identifier (B.1).
- Paraphrased prompts. C.1 means verbatim, as a file.
- "Default settings." Capture
temperature,seed,n_runs, or state explicitly that the model exposes none. - No human validation. E.1 is what licenses reading outputs as the construct (sentiment, stance, moral judgment); an unvalidated pipeline is a finding waiting to be retracted.
- Logging at write-up. Reconstructing versions months later is exactly the failure GUIDE-LLM exists to prevent.
- Padding with editorial use. "Claude helped write the intro" is an AI-use disclosure, not an instrument.
Next
/mstack:data-acquire when LLM outputs become a dataset (log provenance there too, cross-referencing code_ref); /mstack:preregister when LLM use is confirmatory (pre-commit prompts, model version, validation plan; the ledger then documents adherence); /mstack:survey-build when simulated agents or LLM-generated stimuli enter a survey; /mstack:draft-section methods to paste or \input the block; /mstack:archive collects the ledger, prompt files, and call scripts; /mstack:learn for conventions that generalize.
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.

