Download

Reference

Rendered from the Markdown in the repository's docs/ folder, not copied from it, so the site and a checkout cannot disagree.

Documents

  1. Adding a source to resmon resmon queries scholarly sources and keeps what it finds. Adding another one is the most common contribution, and the most templated: the files it touches are listed below, and a… docs/adding-a-source.md
  2. The backup bundle format For someone restoring a resmon backup by hand, or writing a tool that reads one. The user-facing account is the guide's Backup and restore page; this is the file layout and the ma… docs/backup.md
  3. DBLP reliability contract resmon uses two documented DBLP routes for two distinct questions: docs/dblp-reliability.md
  4. The webhook receiver contract resmon can deliver a watch's report to an HTTPS endpoint you own. This page is what you need to write the thing on the other end. It documents the webhook channel's behavior; the… docs/delivery.md
  5. HAL request reliability HAL searches use one 45-second cooperative I/O budget for the entire search, including pagination, rate-limit admission, request setup, retry delays and response reading. Each HTT… docs/hal-reliability.md
  6. Local API security model resmon's renderer, its MCP server and its assistant all talk to the Python backend over HTTP on 127.0.0.1. That API answers only requests that prove they belong to this app. This… docs/local-api-security.md
  7. Read a saved answer offline In Library › Evidence, open a saved selected-evidence question or manual structured briefing and choose Save as HTML. Open the .html file in a browser. The file remains readable a… docs/portable-briefing.md
  8. Scholarly source landscape Survey date: 2026-08-30. This is a product-compatibility review of published provider terms, not legal advice. Terms and API behavior can change; re-check the cited first-party pa… docs/source-landscape.md
  9. Source response reliability bioRxiv, medRxiv, ERIC, and DBLP can return a successful transport response whose body is empty, malformed, or an access-challenge page. Those replies are not valid empty search r… docs/source-response-reliability.md
  10. Third-party notices resmon itself is MIT-licensed (see LICENSE). This file carries the notices for third-party components that resmon redistributes inside its installers — where a copy of the license… docs/third-party-notices.md
  11. The watchdog's zero rules, run against a real corpus Two watchdog rules read a source's recorded zero reason. A rule that has never met real history is not calibrated, it is guessed, so both were run on September 4, 2026 against a c… docs/watchdog-field-test.md
  12. Zenodo search timing and outcomes Zenodo uses one 45-second cooperative search budget, shared by every page, rate-limiter wait, request and retry. Each HTTP request uses 10-second phase timeouts and permits one re… docs/zenodo-reliability.md

The API contract

Generated from the running application by implementation_scripts/api_contract.py and guarded by verification_scripts/test_api_contract.py, which regenerates both files and fails on any difference. Published here, never edited here.

  1. Assistant choices (schema 15) Choices bind a future conversation to the existing Claude CLI or API-key assistant adapter. They do not identify an account, executable build, resolved alias, price or provider-ve… docs/api-contract/assistant-choices.md
  2. Saved conversations: browse, snapshot, export The Chats page reads the assistant tables and the schema-15 choice metadata. It adds no runtime, permission or filesystem endpoint. Creation of a conversation and continuation of… docs/api-contract/assistant-conversations.md
  3. Evidence workspace Evidence joins explicit projects to immutable local Library versions. Start in Library, import or choose a file, follow Open in Evidence / add to project, choose the intended proj… docs/api-contract/evidence.md
  4. The HTTP surface, by journey A declared model is a lower bound on the body, not an exact description. Every one of them is an additionalProperties: true schema, because FastAPI filters a response against its… docs/api-contract/http.md
  5. Library: owned copies and bounded text Library pairs one explicitly created child vault with one application database. The user chooses an existing parent directory and confirms Create; no existing folder is adopted. T… docs/api-contract/library.md
  6. The resmon MCP tool surface — contract 1.0 Two things consume the same surface: external harnesses (Claude Code, Codex, anything else speaking MCP) and resmon's own embedded assistant. It is built once and consumed twice,… docs/api-contract/mcp.md
  7. docs/api-contract/ — the seam, written down The backend and the renderer talk only over HTTP on 127.0.0.1. That boundary is the one place where work on either side can break the other, so it is the one place worth freezing.… docs/api-contract/README.md
  8. Selected-evidence answers A project can send an explicit selection of retained file versions, physical PDF pages, complete canonical text pages or exact Unicode codepoint passages to an existing CLI/API co… docs/api-contract/selected-evidence.md
  9. openapi.json The OpenAPI document for every route, served as the file the generator writes. docs/api-contract/openapi.json