crossref-local

name: crossref-local description: | [WHAT] Offline, zero-API-key DOI lookup + full-text search over the CrossRef corpus. [WHEN] Use when the user asks to "look up a DOI", "resolve DOI to BibTeX", "find a paper by DOI", "enrich BibTeX with missing fields". [HOW] `import crossref_local` then call `habanero.Crossref()`. tags: [crossref-local] allowed-tools: mcpscitexcrossref_* primary_interface: python interfaces: python: 3 cli: 2 mcp: 2 skills: 2 hook: 0 http: 0

Interfaces: Python ⭐⭐⭐ (primary) · CLI ⭐⭐ · MCP ⭐⭐ · Skills ⭐⭐ · Hook — · HTTP —

Local mirror of the CrossRef database with FTS5 full-text search across 167M+ scholarly works — offline, millisecond queries, no rate limits. Also exposes citation networks, per-topic caches, and an HTTP/MCP relay.

Installation & import

pip install crossref-local installs the standalone:

import crossref_local

This package does not ship as a submodule of the scitex umbrella.

Mandatory

01_installation.md — pip install + extras + verify
02_quick-start.md — search / get / enrich / relay
03_python-api.md — Public callables grouped by area
04_cli-reference.md — crossref-local console entry

Deep-dive

13_configuration.md — env vars, DB vs HTTP mode, relay server
14_search.md — search(), count(), exists(), FTS5 syntax
15_retrieval.md — get(), get_many(), enrich(), enrich_dois()
16_models.md — Work, SearchResult dataclasses
05_citations.md — get_citing(), get_cited(), CitationNetwork
17_checker.md — check_citations(), check_bibtex(), check_doi_list()
07_cache.md — topic caches: create, query, stats, plots, export
08_export.md — save() with json / bibtex / text formats
09_async.md — aio.search(), aio.count_many()

Interfaces

10_cli.md — crossref-local CLI (search, check, relay, mcp)
11_mcp.md — MCP server, tools reference, client config
06_http-api.md — FastAPI routes (works, citations, collections, compat)

Environment

12_env-vars.md — SCITEX_* env vars read by crossref-local at runtime