SPB Git

Repository Public Research preview

README.md 2.1 KB 47 lines markdown

1# citation-verification23An agent skill for checking references instead of trusting them. It teaches the rule that4matters (a DOI must resolve **and** its registered metadata must match the citation) and ships5a command-line tool that applies it to one citation or a whole bibliography.67```bash8node scripts/scholarly.mjs verify-bib references.bib --format md --out audit.md9node scripts/scholarly.mjs verify-doi 10.1016/0304-4076(86)90063-1 --title "Generalized autoregressive conditional heteroskedasticity" --year 198610node scripts/scholarly.mjs retractions --bib references.bib11node scripts/scholarly.mjs help12```1314## What is inside1516- `SKILL.md` — the rules, the statuses and the workflows (audit a manuscript, add a reference,17  preprints, retractions, literature search).18- `scripts/scholarly.mjs` — the tool. Node.js 20+, no dependency, JSON output.19- `scripts/lib/` — the engine, identical to the one in `@spboucher/scholarly-mcp`.20- `references/` — thresholds and status definitions, source coverage and limits, report template.2122## Requirements2324Node.js 20 or newer and network access to Crossref, OpenAlex, arXiv and doi.org. No account.25Optional environment variables: `OPENALEX_API_KEY`, `SCHOLARLY_MAILTO`, `SCHOLARLY_ROOT`,26`SCHOLARLY_TIMEOUT_MS`.2728## Privacy2930Requests carry a generic client name. The titles, DOIs and author names you check are sent to31the four services; nothing else is. No contact address is sent unless you set32`SCHOLARLY_MAILTO` yourself.3334## Limits3536- Comparisons are string heuristics with documented thresholds; every verdict comes with the37  claimed and registered values so you can overrule it.38- Books, theses, reports and many regional journals are poorly covered: expect `not_found`, which39  does not mean invented.40- It cannot tell whether a cited work supports the claim citing it.41- Without an OpenAlex key, citation-graph commands share a small daily budget per IP address.42  Verification does not use OpenAlex.43- Not tested: references in non-Latin scripts, bibliographies above a few dozen entries in one44  run, BibLaTeX-only constructs such as `crossref` inheritance and `@xdata`.4546MIT licence.47
Files main
Menu

Theme