jevcrawl 0.1.0__tar.gz

jevcrawl-0.1.0/.gitignore

@@ -0,0 +1,13 @@
+__pycache__/
+*.py[cod]
+.venv*/
+.pytest_cache/
+.ruff_cache/
+.mypy_cache/
+dist/
+*.egg-info/
+.env
+bench/results/
+# local planning documents, not part of the repo
+*.docx
+jevcrawl-claude-code-prompt.md

jevcrawl-0.1.0/LICENSE

@@ -0,0 +1,202 @@
+
+                                 Apache License
+                           Version 2.0, January 2004
+                        http://www.apache.org/licenses/
+
+   TERMS AND CONDITIONS FOR USE, REPRODUCTION, AND DISTRIBUTION
+
+   1. Definitions.
+
+      "License" shall mean the terms and conditions for use, reproduction,
+      and distribution as defined by Sections 1 through 9 of this document.
+
+      "Licensor" shall mean the copyright owner or entity authorized by
+      the copyright owner that is granting the License.
+
+      "Legal Entity" shall mean the union of the acting entity and all
+      other entities that control, are controlled by, or are under common
+      control with that entity. For the purposes of this definition,
+      "control" means (i) the power, direct or indirect, to cause the
+      direction or management of such entity, whether by contract or
+      otherwise, or (ii) ownership of fifty percent (50%) or more of the
+      outstanding shares, or (iii) beneficial ownership of such entity.
+
+      "You" (or "Your") shall mean an individual or Legal Entity
+      exercising permissions granted by this License.
+
+      "Source" form shall mean the preferred form for making modifications,
+      including but not limited to software source code, documentation
+      source, and configuration files.
+
+      "Object" form shall mean any form resulting from mechanical
+      transformation or translation of a Source form, including but
+      not limited to compiled object code, generated documentation,
+      and conversions to other media types.
+
+      "Work" shall mean the work of authorship, whether in Source or
+      Object form, made available under the License, as indicated by a
+      copyright notice that is included in or attached to the work
+      (an example is provided in the Appendix below).
+
+      "Derivative Works" shall mean any work, whether in Source or Object
+      form, that is based on (or derived from) the Work and for which the
+      editorial revisions, annotations, elaborations, or other modifications
+      represent, as a whole, an original work of authorship. For the purposes
+      of this License, Derivative Works shall not include works that remain
+      separable from, or merely link (or bind by name) to the interfaces of,
+      the Work and Derivative Works thereof.
+
+      "Contribution" shall mean any work of authorship, including
+      the original version of the Work and any modifications or additions
+      to that Work or Derivative Works thereof, that is intentionally
+      submitted to Licensor for inclusion in the Work by the copyright owner
+      or by an individual or Legal Entity authorized to submit on behalf of
+      the copyright owner. For the purposes of this definition, "submitted"
+      means any form of electronic, verbal, or written communication sent
+      to the Licensor or its representatives, including but not limited to
+      communication on electronic mailing lists, source code control systems,
+      and issue tracking systems that are managed by, or on behalf of, the
+      Licensor for the purpose of discussing and improving the Work, but
+      excluding communication that is conspicuously marked or otherwise
+      designated in writing by the copyright owner as "Not a Contribution."
+
+      "Contributor" shall mean Licensor and any individual or Legal Entity
+      on behalf of whom a Contribution has been received by Licensor and
+      subsequently incorporated within the Work.
+
+   2. Grant of Copyright License. Subject to the terms and conditions of
+      this License, each Contributor hereby grants to You a perpetual,
+      worldwide, non-exclusive, no-charge, royalty-free, irrevocable
+      copyright license to reproduce, prepare Derivative Works of,
+      publicly display, publicly perform, sublicense, and distribute the
+      Work and such Derivative Works in Source or Object form.
+
+   3. Grant of Patent License. Subject to the terms and conditions of
+      this License, each Contributor hereby grants to You a perpetual,
+      worldwide, non-exclusive, no-charge, royalty-free, irrevocable
+      (except as stated in this section) patent license to make, have made,
+      use, offer to sell, sell, import, and otherwise transfer the Work,
+      where such license applies only to those patent claims licensable
+      by such Contributor that are necessarily infringed by their
+      Contribution(s) alone or by combination of their Contribution(s)
+      with the Work to which such Contribution(s) was submitted. If You
+      institute patent litigation against any entity (including a
+      cross-claim or counterclaim in a lawsuit) alleging that the Work
+      or a Contribution incorporated within the Work constitutes direct
+      or contributory patent infringement, then any patent licenses
+      granted to You under this License for that Work shall terminate
+      as of the date such litigation is filed.
+
+   4. Redistribution. You may reproduce and distribute copies of the
+      Work or Derivative Works thereof in any medium, with or without
+      modifications, and in Source or Object form, provided that You
+      meet the following conditions:
+
+      (a) You must give any other recipients of the Work or
+          Derivative Works a copy of this License; and
+
+      (b) You must cause any modified files to carry prominent notices
+          stating that You changed the files; and
+
+      (c) You must retain, in the Source form of any Derivative Works
+          that You distribute, all copyright, patent, trademark, and
+          attribution notices from the Source form of the Work,
+          excluding those notices that do not pertain to any part of
+          the Derivative Works; and
+
+      (d) If the Work includes a "NOTICE" text file as part of its
+          distribution, then any Derivative Works that You distribute must
+          include a readable copy of the attribution notices contained
+          within such NOTICE file, excluding those notices that do not
+          pertain to any part of the Derivative Works, in at least one
+          of the following places: within a NOTICE text file distributed
+          as part of the Derivative Works; within the Source form or
+          documentation, if provided along with the Derivative Works; or,
+          within a display generated by the Derivative Works, if and
+          wherever such third-party notices normally appear. The contents
+          of the NOTICE file are for informational purposes only and
+          do not modify the License. You may add Your own attribution
+          notices within Derivative Works that You distribute, alongside
+          or as an addendum to the NOTICE text from the Work, provided
+          that such additional attribution notices cannot be construed
+          as modifying the License.
+
+      You may add Your own copyright statement to Your modifications and
+      may provide additional or different license terms and conditions
+      for use, reproduction, or distribution of Your modifications, or
+      for any such Derivative Works as a whole, provided Your use,
+      reproduction, and distribution of the Work otherwise complies with
+      the conditions stated in this License.
+
+   5. Submission of Contributions. Unless You explicitly state otherwise,
+      any Contribution intentionally submitted for inclusion in the Work
+      by You to the Licensor shall be under the terms and conditions of
+      this License, without any additional terms or conditions.
+      Notwithstanding the above, nothing herein shall supersede or modify
+      the terms of any separate license agreement you may have executed
+      with Licensor regarding such Contributions.
+
+   6. Trademarks. This License does not grant permission to use the trade
+      names, trademarks, service marks, or product names of the Licensor,
+      except as required for reasonable and customary use in describing the
+      origin of the Work and reproducing the content of the NOTICE file.
+
+   7. Disclaimer of Warranty. Unless required by applicable law or
+      agreed to in writing, Licensor provides the Work (and each
+      Contributor provides its Contributions) on an "AS IS" BASIS,
+      WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or
+      implied, including, without limitation, any warranties or conditions
+      of TITLE, NON-INFRINGEMENT, MERCHANTABILITY, or FITNESS FOR A
+      PARTICULAR PURPOSE. You are solely responsible for determining the
+      appropriateness of using or redistributing the Work and assume any
+      risks associated with Your exercise of permissions under this License.
+
+   8. Limitation of Liability. In no event and under no legal theory,
+      whether in tort (including negligence), contract, or otherwise,
+      unless required by applicable law (such as deliberate and grossly
+      negligent acts) or agreed to in writing, shall any Contributor be
+      liable to You for damages, including any direct, indirect, special,
+      incidental, or consequential damages of any character arising as a
+      result of this License or out of the use or inability to use the
+      Work (including but not limited to damages for loss of goodwill,
+      work stoppage, computer failure or malfunction, or any and all
+      other commercial damages or losses), even if such Contributor
+      has been advised of the possibility of such damages.
+
+   9. Accepting Warranty or Additional Liability. While redistributing
+      the Work or Derivative Works thereof, You may choose to offer,
+      and charge a fee for, acceptance of support, warranty, indemnity,
+      or other liability obligations and/or rights consistent with this
+      License. However, in accepting such obligations, You may act only
+      on Your own behalf and on Your sole responsibility, not on behalf
+      of any other Contributor, and only if You agree to indemnify,
+      defend, and hold each Contributor harmless for any liability
+      incurred by, or claims asserted against, such Contributor by reason
+      of your accepting any such warranty or additional liability.
+
+   END OF TERMS AND CONDITIONS
+
+   APPENDIX: How to apply the Apache License to your work.
+
+      To apply the Apache License to your work, attach the following
+      boilerplate notice, with the fields enclosed by brackets "[]"
+      replaced with your own identifying information. (Don't include
+      the brackets!)  The text should be enclosed in the appropriate
+      comment syntax for the file format. We also recommend that a
+      file or class name and description of purpose be included on the
+      same "printed page" as the copyright notice for easier
+      identification within third-party archives.
+
+   Copyright [yyyy] [name of copyright owner]
+
+   Licensed under the Apache License, Version 2.0 (the "License");
+   you may not use this file except in compliance with the License.
+   You may obtain a copy of the License at
+
+       http://www.apache.org/licenses/LICENSE-2.0
+
+   Unless required by applicable law or agreed to in writing, software
+   distributed under the License is distributed on an "AS IS" BASIS,
+   WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+   See the License for the specific language governing permissions and
+   limitations under the License.

jevcrawl-0.1.0/PKG-INFO

@@ -0,0 +1,271 @@
+Metadata-Version: 2.5
+Name: jevcrawl
+Version: 0.1.0
+Summary: MCP server and CLI that crawls websites for AI agents: a small decision model (Jev) picks the pages and passages, so the agent's LLM only reads what answers its question.
+Project-URL: Homepage, https://github.com/RayenMlayeh/jevcrawl
+Project-URL: Issues, https://github.com/RayenMlayeh/jevcrawl/issues
+Author: Rayen Mlayeh
+License-Expression: Apache-2.0
+License-File: LICENSE
+Keywords: ai-agents,jev,mcp,mcp-server,typesafe,web-crawler,web-scraping
+Classifier: Development Status :: 3 - Alpha
+Classifier: Intended Audience :: Developers
+Classifier: License :: OSI Approved :: Apache Software License
+Classifier: Programming Language :: Python :: 3
+Classifier: Programming Language :: Python :: 3.11
+Classifier: Programming Language :: Python :: 3.12
+Classifier: Programming Language :: Python :: 3.13
+Classifier: Topic :: Internet :: WWW/HTTP
+Classifier: Typing :: Typed
+Requires-Python: >=3.11
+Requires-Dist: httpx[http2]>=0.27
+Requires-Dist: mcp>=1.2
+Requires-Dist: selectolax>=1.0
+Requires-Dist: w3lib>=2.1
+Provides-Extra: bench
+Requires-Dist: anthropic; extra == 'bench'
+Requires-Dist: datasets; extra == 'bench'
+Provides-Extra: crawl4ai
+Requires-Dist: crawl4ai; extra == 'crawl4ai'
+Description-Content-Type: text/markdown
+
+<div align="center">
+
+<picture>
+  <source media="(prefers-color-scheme: dark)" srcset="https://raw.githubusercontent.com/RayenMlayeh/jevcrawl/main/assets/logo-dark.svg">
+  <img alt="jevcrawl" src="https://raw.githubusercontent.com/RayenMlayeh/jevcrawl/main/assets/logo-light.svg" width="400">
+</picture>
+
+### The web crawler for AI agents that finds the answer, not just pages.
+
+A small decision model picks every link and every passage, so your agent's LLM reads
+**only what answers its question** at **a few cents per crawl**.
+
+[![PyPI](https://img.shields.io/pypi/v/jevcrawl?color=6D5DFC)](https://pypi.org/project/jevcrawl/)
+[![CI](https://github.com/RayenMlayeh/jevcrawl/actions/workflows/ci.yml/badge.svg)](https://github.com/RayenMlayeh/jevcrawl/actions/workflows/ci.yml)
+[![License](https://img.shields.io/badge/license-Apache--2.0-6D5DFC)](https://github.com/RayenMlayeh/jevcrawl/blob/main/LICENSE)
+[![Python](https://img.shields.io/badge/python-3.11%2B-3776AB?logo=python&logoColor=white)](https://github.com/RayenMlayeh/jevcrawl/blob/main/pyproject.toml)
+[![MCP server](https://img.shields.io/badge/MCP-server-22C3EE)](https://modelcontextprotocol.io)
+[![Benchmark](https://img.shields.io/badge/WebWalkerQA-40%25_vs_30%25_for_Claude-6D5DFC)](#benchmarks)
+[![Cost](https://img.shields.io/badge/cost-%240.025%2Ftask-2EA043)](#cost-and-privacy)
+
+[Quick start](#quick-start) · [Benchmarks](#benchmarks) · [Tools](#tools) ·
+[How it works](#how-it-works) · [Configuration](#configuration)
+
+</div>
+
+<br>
+
+<p align="center">
+  <img alt="Demo: jevcrawl crawls docs.python.org for 'What does the walrus operator := do and which Python version added it?' and returns the What's New In Python 3.8 passage. 6 pages, 80,034 tokens reduced to 1,873, $0.0069, 8.3 seconds." src="https://raw.githubusercontent.com/RayenMlayeh/jevcrawl/main/assets/demo.svg" width="100%">
+</p>
+
+<picture>
+  <source media="(prefers-color-scheme: dark)" srcset="https://raw.githubusercontent.com/RayenMlayeh/jevcrawl/main/assets/scoreboard-dark.svg">
+  <img alt="On 50 WebWalkerQA tasks jevcrawl answered 40% correctly and found the answer page 54% of the time for $0.025 per task, against 30%, 33% and $0.194 when Claude picks every link and 8%, 11% and $0.228 for a breadth-first crawl." src="https://raw.githubusercontent.com/RayenMlayeh/jevcrawl/main/assets/scoreboard-light.svg" width="100%">
+</picture>
+
+## Why jevcrawl
+
+Agents that browse a site have two bad options. They can **read everything** a crawler fetches,
+which buries the answer in navigation and boilerplate and burns tokens. Or they can **let the LLM
+pick each link**, which is slow and costs dollars per question. jevcrawl does neither:
+
+- 🎯 **Finds the answer page more often.** 54% of tasks vs 33% when Claude picks the links, and
+  2x as often as [Crawl4AI](#jevcrawl-vs-crawl4ai)'s goal-directed crawl.
+- 💸 **About 8x cheaper per task, 10x per correct answer.** The crawl decisions cost about a cent.
+- ⚡ **2x faster than an LLM-driven crawl.** Four pages at a time, one decision request per page.
+- 📜 **Verbatim, with sources.** Every passage is copied from the page with its URL, heading path
+  and character offsets. The decision model only scores, so it cannot invent text.
+- 🛡️ **Safe against prompt injection by design.** Page text is only ever scored, never followed.
+- 🔌 **Works everywhere MCP does:** Claude Code, Claude Desktop, Cursor, or the CLI.
+
+## Quick start
+
+You need a Jev API key from [console.typesafe.ai](https://console.typesafe.ai/) and
+[uv](https://docs.astral.sh/uv/).
+
+**Claude Code**
+
+```bash
+claude mcp add jevcrawl -e TYPESAFE_API_KEY=<your key> -- uvx jevcrawl
+```
+
+**Claude Desktop, Cursor and other MCP clients** (`mcpServers` in the client's config file)
+
+```json
+{
+  "mcpServers": {
+    "jevcrawl": {
+      "command": "uvx",
+      "args": ["jevcrawl"],
+      "env": { "TYPESAFE_API_KEY": "<your key>" }
+    }
+  }
+}
+```
+
+Then ask your agent something like *"Use jevcrawl to find which Python version added the walrus
+operator, starting from docs.python.org"*. Check the setup with
+`uvx jevcrawl doctor`. Agents that load skills
+can also use [`skills/jevcrawl/SKILL.md`](https://github.com/RayenMlayeh/jevcrawl/blob/main/skills/jevcrawl/SKILL.md).
+
+## Benchmarks
+
+Every system starts on a site's home page with the same 30-page budget and the same question.
+What each one collects goes to the **same answering LLM**, and the **same judge** grades the
+answer, so the crawler is the only thing that changes.
+
+<picture>
+  <source media="(prefers-color-scheme: dark)" srcset="https://raw.githubusercontent.com/RayenMlayeh/jevcrawl/main/assets/cost-dark.svg">
+  <img alt="Cost of one correct answer: jevcrawl $0.06, Claude picking every link $0.65, breadth-first crawl $2.85." src="https://raw.githubusercontent.com/RayenMlayeh/jevcrawl/main/assets/cost-light.svg" width="100%">
+</picture>
+
+### jevcrawl vs Crawl4AI
+
+[Crawl4AI](https://github.com/unclecode/crawl4ai) is one of the most popular open-source crawlers
+for LLMs. Its `BestFirstCrawlingStrategy` with a keyword scorer is its way to crawl toward a question
+without an LLM, so we compared the two on whether they fetch the page that holds the answer.
+
+<picture>
+  <source media="(prefers-color-scheme: dark)" srcset="https://raw.githubusercontent.com/RayenMlayeh/jevcrawl/main/assets/crawl4ai-dark.svg">
+  <img alt="On 20 tasks jevcrawl found an answer page 10 times and Crawl4AI 5 times; every answer page 5 vs 2; median crawl time 29 s vs 43 s; sites that failed to load 0 vs 3. jevcrawl found 6 answer pages Crawl4AI missed, Crawl4AI found 1 jevcrawl missed." src="https://raw.githubusercontent.com/RayenMlayeh/jevcrawl/main/assets/crawl4ai-light.svg" width="100%">
+</picture>
+
+### Where the numbers come from
+
+| | |
+|---|---|
+| **Tasks** | [WebWalkerQA](https://huggingface.co/datasets/callanwu/WebWalkerQA) from *WebWalker: Benchmarking LLMs in Web Traversal* (Wu et al., Alibaba Tongyi Lab, [ACL 2025](https://arxiv.org/abs/2501.07572)): questions whose answers sit several clicks deep in real websites (conferences, universities, organizations, games), in English and Chinese. |
+| **Task selection** | Each task was re-checked live before the run: the site and answer page still load and still contain the reference answer. Tasks looked at while developing are excluded ([`bench/tasks/seen-ids.txt`](https://github.com/RayenMlayeh/jevcrawl/blob/main/bench/tasks/seen-ids.txt)). |
+| **Accuracy run** | 50 tasks, 2026-10-12. Answering model `claude-opus-5-5`, judge `claude-sonnet-5-5`. |
+| **Crawl4AI run** | 20 different tasks, 2026-10-13, Crawl4AI 0.9.4. Crawl only, no LLM: did the crawler fetch the gold page? In the accuracy run, whether a system fetched the gold page closely tracked whether it answered correctly. |
+| **Baselines** | *Claude picks every link*: Claude reads each page and chooses the next link. *Breadth-first*: every page to depth 2. All systems share jevcrawl's fetcher and remove navigation and footers. |
+| **Costs** | Jev cost is billed and exact. LLM costs are token counts at list price. |
+| **Caveats** | 50 and 20 tasks are small samples: the cost gap is large and stable, the accuracy gap less so. Crawl4AI drives a real browser, jevcrawl does not run JavaScript. |
+
+The benchmark code and how to reproduce every number: [`bench/`](https://github.com/RayenMlayeh/jevcrawl/blob/main/bench/README.md).
+
+## Tools
+
+| Tool | Use it for |
+|---|---|
+| `crawl(goal, start_url, max_pages=30, max_seconds=120, return_tokens=4000, max_decision_usd=0.05)` | The answer may be several pages deep. Returns the relevant passages. |
+| `scrape(url, goal=None)` | One known page. With a goal, only the relevant passages; without one, all content and no Jev call. |
+| `map(start_url, goal, limit=50, max_pages=10)` | Ranked URLs only, to decide what to `scrape`. |
+
+<details>
+<summary><b>A real result</b> (docs.python.org, "What does the walrus operator := do and which Python version added it?")</summary>
+
+```json
+{"blocks": [{"url": "https://docs.python.org/3/whatsnew/3.8.html",
+             "heading_path": "What’s New In Python 3.8 > New Features > Assignment expressions",
+             "text": "There is new syntax := that assigns values to variables as part of a larger expression. ...",
+             "char_start": 307, "char_end": 580, "relevance": 0.97}],
+ "uncertain": [],
+ "pages": [{"url": "https://docs.python.org/3/", "title": "3.15.0 Documentation", "lang": "en",
+            "text_sha256": "b624ce93..."}],
+ "stats": {"pages_fetched": 6, "tokens_raw": 80034, "tokens_returned": 1873, "jev_calls": 11,
+           "cache_hits": 0, "jev_input_tokens": 164139, "jev_cost_usd": 0.0069,
+           "model": "jev-1.13.0", "degraded": false, "degraded_reason": null,
+           "needs_js_urls": [], "stopped_because": "answered", "elapsed_seconds": 8.3}}
+```
+
+Trimmed to one block and one page. 80,034 tokens of pages became 1,873 tokens of answer, for
+$0.0069, in 8.3 seconds.
+
+- `blocks` are the relevant passages, best first; `uncertain` are borderline ones worth reading
+  before concluding something is missing.
+- `char_start`/`char_end` index into the page text whose sha256 is in `pages`, so a quote can be
+  checked later.
+- `stopped_because` is `answered`, `frontier_empty`, `max_pages`, `max_seconds`, `budget` or
+  `auth_error`.
+- Expected failures come back as `{"error": "<code>", "message": "<what to do>"}`; the tools
+  never raise into the agent's session.
+
+</details>
+
+The same operations work from the command line (`uv tool install jevcrawl` or
+`pip install jevcrawl` puts `jevcrawl` on your path):
+
+```bash
+jevcrawl crawl https://docs.python.org/3/ --goal "What does the walrus operator do?" [--json]
+jevcrawl scrape https://example.com/help/returns [--goal "..."] [--json]
+jevcrawl map https://example.com --goal "..." [--limit 20]
+jevcrawl doctor
+```
+
+## How it works
+
+<picture>
+  <source media="(prefers-color-scheme: dark)" srcset="https://raw.githubusercontent.com/RayenMlayeh/jevcrawl/main/assets/how-dark.svg">
+  <img alt="A crawl in six steps: seed from the sitemap, fetch the best 4 pages, segment them into passages, filter boilerplate for free, Jev scores every passage and link in one request per page, Jev checks whether the kept passages answer the goal. If not, it follows the next best links. The docs.python.org example turned 80,034 tokens of pages into 1,873 tokens for $0.0069 in 8.3 s." src="https://raw.githubusercontent.com/RayenMlayeh/jevcrawl/main/assets/how-light.svg" width="100%">
+</picture>
+
+- **Jev decides, it does not write.** [Jev](https://typesafe.ai) returns a probability per
+  yes/no question, so it cannot produce text. Everything you get back is copied from the page.
+- **Page text is data, never instructions.** It travels only in data fields of a question; every
+  question sentence is a fixed string written by jevcrawl. An injected "ignore previous
+  instructions" can at worst bias a score.
+- **Links below the priority floor are kept in reserve**, not dropped, so a crawl never stops
+  early while it still has page budget.
+- **Failures degrade, they do not hide.** After three failed Jev requests the crawl continues
+  breadth-first, returns every block unscored in `uncertain`, and sets `stats.degraded`.
+- **Repeats are free.** Jev's answers are cached locally (`~/.jevcrawl/cache`), so the same goal
+  on the same pages costs nothing.
+
+## Configuration
+
+| Environment variable | Meaning | Default |
+|---|---|---|
+| `TYPESAFE_API_KEY` | Jev API key (required) | none |
+| `JEVCRAWL_BASE_URL` | Jev-compatible endpoint | `https://api.typesafe.ai` |
+| `JEVCRAWL_MODEL` | model id | `jev-1.13.0` (pinned: thresholds are calibrated per version) |
+| `JEVCRAWL_CACHE_DIR` | answer cache | `~/.jevcrawl/cache` |
+
+Everything else (thresholds, links per page, concurrency) has a measured default in
+[`jevcrawl/config.py`](https://github.com/RayenMlayeh/jevcrawl/blob/main/jevcrawl/config.py), and Python callers can pass their own `Config`.
+
+## Cost and privacy
+
+Jev charges for input tokens only, $0.042 per million for `jev-1.13.0`; in the benchmark a crawl
+cost $0.011 on average. `max_decision_usd` is a hard limit: a request that could pass it is never
+sent, and the crawl stops with `budget`. Every result reports `jev_cost_usd`, and `tokens_raw`
+(what a plain crawl would hand your LLM) against `tokens_returned`.
+
+**Page text is sent to TypeSafe** (blocks, link labels and URLs) to be scored. The API key is
+read from the environment and never written to disk or logs.
+
+## Crawling responsibly
+
+jevcrawl does not read `robots.txt` and does not rate-limit itself beyond fetching four pages at
+a time. You are responsible for the sites you crawl, their terms of service and the law that
+applies to you. It never logs in, does not try to get past paywalls or CAPTCHAs, and does not
+run JavaScript (pages that need it are listed in `stats.needs_js_urls`). Every call is bounded by
+`max_pages`, `max_seconds`, `max_decision_usd` and `return_tokens`.
+
+## Contributing
+
+```bash
+uv sync
+uv run ruff check . && uv run ruff format --check . && uv run mypy --strict jevcrawl
+uv run pytest                                    # offline: all HTTP is mocked
+TYPESAFE_API_KEY=... uv run pytest -m live -s    # one tiny real request, a fraction of a cent
+```
+
+Tests never touch the network or spend money; anything that does is marked `live`. The README
+charts are drawn by [`assets/build.py`](https://github.com/RayenMlayeh/jevcrawl/blob/main/assets/build.py) from the measured numbers. Issues and
+pull requests are welcome; please report security problems as described in
+[SECURITY.md](https://github.com/RayenMlayeh/jevcrawl/blob/main/SECURITY.md).
+
+## Acknowledgments
+
+- [WebWalkerQA](https://github.com/Alibaba-NLP/WebAgent) by Alibaba's Tongyi Lab, for a
+  benchmark of questions that really need crawling.
+- [Crawl4AI](https://github.com/unclecode/crawl4ai), the baseline we measure against.
+- [Model Context Protocol](https://modelcontextprotocol.io), [selectolax](https://github.com/rushter/selectolax)
+  and [httpx](https://www.python-httpx.org/).
+
+## License
+
+[Apache-2.0](https://github.com/RayenMlayeh/jevcrawl/blob/main/LICENSE)