bucketlens 0.1.0__tar.gz

bucketlens-0.1.0/.github/workflows/ci.yml

@@ -0,0 +1,17 @@
+name: ci
+on:
+  push:
+    branches: [main]
+  pull_request:
+jobs:
+  test:
+    runs-on: ubuntu-latest
+    strategy:
+      matrix:
+        python: ["3.10", "3.11", "3.12"]
+    steps:
+      - uses: actions/checkout@v4
+      - uses: astral-sh/setup-uv@v5
+      - run: uv venv --python ${{ matrix.python }} && uv pip install -e ".[dev]"
+      - run: .venv/bin/ruff check .
+      - run: .venv/bin/python -m pytest -q -p no:logging

bucketlens-0.1.0/.github/workflows/release.yml

@@ -0,0 +1,45 @@
+name: release
+# Push a tag like v0.1.0. This builds the package, publishes it to PyPI (trusted publishing, no
+# token stored here), then lists the new version in the official MCP Registry (GitHub OIDC login).
+on:
+  push:
+    tags: ["v*"]
+jobs:
+  pypi:
+    runs-on: ubuntu-latest
+    environment: pypi
+    permissions:
+      id-token: write
+      contents: read
+    steps:
+      - uses: actions/checkout@v4
+      - uses: astral-sh/setup-uv@v5
+      - name: Versions match the tag
+        run: |
+          tag="${GITHUB_REF_NAME#v}"
+          py=$(grep -m1 '^version = ' pyproject.toml | cut -d'"' -f2)
+          sj=$(python3 -c "import json;d=json.load(open('server.json'));print(d['version'], d['packages'][0]['version'])")
+          echo "tag=$tag pyproject=$py server.json=$sj"
+          [ "$py" = "$tag" ] && [ "$sj" = "$tag $tag" ]
+      - run: uv build
+      - uses: pypa/gh-action-pypi-publish@release/v1
+  mcp-registry:
+    needs: pypi
+    runs-on: ubuntu-latest
+    permissions:
+      id-token: write
+      contents: read
+    steps:
+      - uses: actions/checkout@v4
+      - name: Install mcp-publisher
+        run: |
+          curl -fsSL "https://github.com/modelcontextprotocol/registry/releases/latest/download/mcp-publisher_linux_amd64.tar.gz" | tar xz mcp-publisher
+      - name: Wait for PyPI to serve the new version
+        run: |
+          for i in $(seq 1 30); do
+            curl -fsS "https://pypi.org/pypi/bucketlens/${GITHUB_REF_NAME#v}/json" >/dev/null && exit 0
+            sleep 10
+          done
+          exit 1
+      - run: ./mcp-publisher login github-oidc
+      - run: ./mcp-publisher publish

bucketlens-0.1.0/.gitignore

@@ -0,0 +1,11 @@
+.venv/
+__pycache__/
+*.pyc
+.pytest_cache/
+.ruff_cache/
+dist/
+build/
+*.egg-info/
+benchmarks/results/runs/
+*.env
+.DS_Store

bucketlens-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.

bucketlens-0.1.0/PKG-INFO

@@ -0,0 +1,195 @@
+Metadata-Version: 2.5
+Name: bucketlens
+Version: 0.1.0
+Summary: Let any AI agent read the documents and spreadsheets in your own S3 or R2 bucket: outlines, pages, rows, SQL and search, without downloading the files.
+Project-URL: Homepage, https://github.com/Pritom14/bucketlens
+Author: Pritom Mazumdar
+License-Expression: Apache-2.0
+License-File: LICENSE
+Keywords: agents,documents,excel,llm,mcp,pdf,r2,s3
+Classifier: License :: OSI Approved :: Apache Software License
+Classifier: Programming Language :: Python :: 3
+Classifier: Topic :: Scientific/Engineering :: Artificial Intelligence
+Requires-Python: >=3.10
+Requires-Dist: boto3>=1.34
+Requires-Dist: duckdb>=1.2
+Requires-Dist: mcp>=2.0
+Requires-Dist: openpyxl>=3.1
+Requires-Dist: pypdfium2>=4.30
+Provides-Extra: dev
+Requires-Dist: fpdf2>=2.7; extra == 'dev'
+Requires-Dist: moto[server]>=5; extra == 'dev'
+Requires-Dist: pytest>=8; extra == 'dev'
+Requires-Dist: ruff>=0.6; extra == 'dev'
+Requires-Dist: xlsxwriter>=3.1; extra == 'dev'
+Description-Content-Type: text/markdown
+
+# bucketlens
+
+<!-- mcp-name: io.github.Pritom14/bucketlens -->
+
+[![ci](https://github.com/Pritom14/bucketlens/actions/workflows/ci.yml/badge.svg)](https://github.com/Pritom14/bucketlens/actions/workflows/ci.yml)
+[![python](https://img.shields.io/badge/python-3.10%20%7C%203.11%20%7C%203.12-3776ab)](pyproject.toml)
+[![license](https://img.shields.io/badge/license-Apache--2.0-4f46e5)](LICENSE)
+[![MCP](https://img.shields.io/badge/MCP-server-111827)](https://modelcontextprotocol.io)
+
+Let any AI agent read the documents and spreadsheets in your own S3 or R2 bucket, without
+downloading them.
+
+Agents work best the way a developer does: look at what's there, search, open just the part
+that matters. That works on code, because code is plain text on a local disk. A company's
+knowledge is PDFs, spreadsheets and contracts in a bucket. An agent with a shell downloads and
+parses them on every run. An agent without one (a chat app, Claude Desktop, a support bot, an
+MCP-only client) often can't use them at all.
+
+bucketlens is an MCP server. It parses each file once, keeps the result next to the file in your
+bucket, and lets the agent ask for exactly what it needs: an outline, pages 36 to 38, a search
+across 100 contracts, or a SQL query over a 400,000-row sheet.
+
+## Results on real files
+
+Claude Code (Sonnet) answered 10 questions about real public files: Berkshire Hathaway's 2025
+annual report and 2026 quarterly reports, the World Bank's 82 MB World Development Indicators
+workbook, and 100 commercial contracts from the CUAD dataset. Each question ran three ways.
+
+| Setup | Right answers | Tokens | Cost | Time |
+|---|---|---|---|---|
+| Downloads the files, has a shell and Python | 10/10 | 226,231 | $0.21 | 405 s |
+| Downloads the files, no shell (like a chat app) | 6/10 | 433,144 | $0.59 | 370 s |
+| bucketlens (no files, no shell) | **10/10** | **159,280** | $0.23 | **141 s** |
+| bucketlens, re-run with the released v0.1 package | **10/10** | 182,630 | $0.30 | 165 s |
+
+By dataset:
+
+| Dataset | Shell | No shell | bucketlens |
+|---|---|---|---|
+| Berkshire reports (154-page annual report, 3 quarterlies) | 5/5, 67 s | 5/5, 2.9x the tokens | 5/5, 48 s |
+| World Bank workbook (82 MB, 398,468 rows) | 3/3, 240 s | **0/3**, can't open .xlsx | 3/3, 52 s |
+| 100 contracts (1,481 pages) | 2/2, 98 s | **1/2** | 2/2, 41 s |
+
+What this says, honestly:
+
+- **Agents without a shell are where bucketlens changes the outcome.** They can't open a
+  spreadsheet at all, and across many files they give up or spend many turns reading.
+- **Agents with a shell get the same answers either way.** bucketlens is about 2.5x faster for them
+  (no downloads; the 82 MB workbook alone took 20 to 65 s to download) and uses fewer tokens. It is
+  not cheaper: $0.23 and $0.30 across two runs, against $0.21, because tool results are fresh input
+  while a shell agent's long prompt is mostly cached.
+
+The answers were checked automatically against values taken from the files. The 2026 quarterly
+figures are newer than the model's training data, so they had to be read, not remembered.
+Details and earlier runs on synthetic data: [benchmarks/RESULTS.md](benchmarks/RESULTS.md).
+
+## Quick start
+
+bucketlens is an MCP server. Install it, point it at a bucket, and add it to any MCP client.
+
+```bash
+pip install bucketlens            # or: uv tool install bucketlens
+bucketlens setup                  # bucket + keys, typed hidden, saved to ~/.config/bucketlens/config.env
+bucketlens index                  # parse every PDF, XLSX and CSV once (optional; files are also indexed on first use)
+```
+
+**Claude Code**
+
+```bash
+claude mcp add bucketlens -- bucketlens serve
+```
+
+**Claude Desktop, Cursor, or any client that takes a JSON config** (no install needed with `uvx`):
+
+```json
+{
+  "mcpServers": {
+    "bucketlens": {
+      "command": "uvx",
+      "args": ["bucketlens", "serve"],
+      "env": {
+        "BUCKETLENS_R2_ACCOUNT_ID": "your Cloudflare account ID (or set BUCKETLENS_ENDPOINT for S3)",
+        "BUCKETLENS_BUCKET": "your-bucket",
+        "BUCKETLENS_ACCESS_KEY_ID": "...",
+        "BUCKETLENS_SECRET_ACCESS_KEY": "..."
+      }
+    }
+  }
+}
+```
+
+If you ran `bucketlens setup`, leave out `env`: the server reads the saved config.
+
+Works with Cloudflare R2, AWS S3, MinIO and other S3-compatible storage. Give it a key that can
+read the bucket and write under `.bucketlens/` (where the index lives). It is listed in the
+official MCP Registry as `io.github.Pritom14/bucketlens`.
+
+## Tools the agent gets
+
+| Tool | What it returns |
+|---|---|
+| `list_files(prefix)` | names, sizes, dates; nothing is downloaded |
+| `outline(path, depth)` | PDF: pages, table of contents with page numbers, token cost of reading it whole. Spreadsheet: sheets, rows, columns and types |
+| `search(path, text)` | pages of one PDF that contain the text, with snippets |
+| `search_all(text, folder, files_only)` | every PDF in a folder at once, as compact hits or just file names and counts |
+| `read_pages(path, pages)` | text of specific pages, e.g. `"36-38"` |
+| `query(path, sql)` | read-only SQL over a spreadsheet or CSV; each sheet is a table |
+| `read_rows(path, sheet, first, last)` | rows by the spreadsheet's own row numbers |
+
+## How it works
+
+The first time a file is touched (or when it's saved, with `watch`), bucketlens reads it once:
+
+- **PDF**: each page's text goes into one `pages.txt` with byte offsets, plus the outline. Reading
+  pages 600 to 602 of a 733-page PDF is then one range request (about 150 KB).
+- **XLSX / CSV**: each sheet becomes a Parquet file with a `_row` column. DuckDB reads only the
+  columns and row groups a query needs (rows 150,000 to 150,049 of a 20 MB workbook: about 190 KB).
+
+Everything is stored under `.bucketlens/index/<file>/<etag>/`. When a file changes its ETag
+changes, so an agent is never answered from an old version.
+
+Why not just read parts of the original file? We measured it: opening a PDF or the first rows of
+a workbook fetches 5 to 7% of the file, but deep pages and deep rows fetch 50 to 75%, because of
+how PDF and XLSX are laid out inside. Parsing once and serving slices is what makes every read
+small.
+
+## Keeping the index fresh
+
+```bash
+bucketlens watch              # Cloudflare R2: event notifications -> Queue, pulled over HTTP
+bucketlens watch --poll 300   # any S3: list the bucket every 5 minutes
+```
+
+With R2 event notifications, a new 492-page PDF was indexed 8.8 s after its upload started, an
+edited workbook 4.4 s after it was saved, and a deleted file's index removed 3 s later. To set it
+up: create a Queue, add an event notification on the bucket (object creation and deletion) that
+sends to it, and add a Cloudflare API token with **Account > Queues > Edit** to the config as
+`BUCKETLENS_CF_API_TOKEN`, with `BUCKETLENS_CF_QUEUE` set to the queue's name.
+
+## Costs
+
+bucketlens itself is free. On Cloudflare R2, the free tier (10 GB of storage, 1 million writes and
+10 million reads a month, free downloads) covered everything in the benchmarks. The index adds
+about 25% to stored bytes for these files. The watcher polls once a minute when idle, about
+1,440 Queue calls a day against a free allowance of 10,000. R2 has no hard spending cap, so set a
+billing alert.
+
+## Security
+
+- Keys stay on your machine, in a file only you can read. bucketlens never prints them.
+- SQL from agents is read-only: one statement, and DuckDB is locked so it can't read or write local
+  files or change its own settings.
+- The agent can read anything in the bucket the key can read. Use a key scoped to one bucket.
+
+## Limits
+
+- Reads PDF, XLSX/XLSM and CSV. Word and PowerPoint are next.
+- Scanned PDFs without a text layer aren't searchable yet (no OCR).
+- The first touch of a file reads it whole; use `watch` or `index` so agents never wait on it.
+- Benchmarks used one agent (Claude Code) and one model (Sonnet).
+
+## Reproduce the benchmarks
+
+See [benchmarks/README.md](benchmarks/README.md). The public files are fetched by a script, not
+stored in this repo.
+
+## License
+
+Apache-2.0

bucketlens-0.1.0/README.md

@@ -0,0 +1,169 @@
+# bucketlens
+
+<!-- mcp-name: io.github.Pritom14/bucketlens -->
+
+[![ci](https://github.com/Pritom14/bucketlens/actions/workflows/ci.yml/badge.svg)](https://github.com/Pritom14/bucketlens/actions/workflows/ci.yml)
+[![python](https://img.shields.io/badge/python-3.10%20%7C%203.11%20%7C%203.12-3776ab)](pyproject.toml)
+[![license](https://img.shields.io/badge/license-Apache--2.0-4f46e5)](LICENSE)
+[![MCP](https://img.shields.io/badge/MCP-server-111827)](https://modelcontextprotocol.io)
+
+Let any AI agent read the documents and spreadsheets in your own S3 or R2 bucket, without
+downloading them.
+
+Agents work best the way a developer does: look at what's there, search, open just the part
+that matters. That works on code, because code is plain text on a local disk. A company's
+knowledge is PDFs, spreadsheets and contracts in a bucket. An agent with a shell downloads and
+parses them on every run. An agent without one (a chat app, Claude Desktop, a support bot, an
+MCP-only client) often can't use them at all.
+
+bucketlens is an MCP server. It parses each file once, keeps the result next to the file in your
+bucket, and lets the agent ask for exactly what it needs: an outline, pages 36 to 38, a search
+across 100 contracts, or a SQL query over a 400,000-row sheet.
+
+## Results on real files
+
+Claude Code (Sonnet) answered 10 questions about real public files: Berkshire Hathaway's 2025
+annual report and 2026 quarterly reports, the World Bank's 82 MB World Development Indicators
+workbook, and 100 commercial contracts from the CUAD dataset. Each question ran three ways.
+
+| Setup | Right answers | Tokens | Cost | Time |
+|---|---|---|---|---|
+| Downloads the files, has a shell and Python | 10/10 | 226,231 | $0.21 | 405 s |
+| Downloads the files, no shell (like a chat app) | 6/10 | 433,144 | $0.59 | 370 s |
+| bucketlens (no files, no shell) | **10/10** | **159,280** | $0.23 | **141 s** |
+| bucketlens, re-run with the released v0.1 package | **10/10** | 182,630 | $0.30 | 165 s |
+
+By dataset:
+
+| Dataset | Shell | No shell | bucketlens |
+|---|---|---|---|
+| Berkshire reports (154-page annual report, 3 quarterlies) | 5/5, 67 s | 5/5, 2.9x the tokens | 5/5, 48 s |
+| World Bank workbook (82 MB, 398,468 rows) | 3/3, 240 s | **0/3**, can't open .xlsx | 3/3, 52 s |
+| 100 contracts (1,481 pages) | 2/2, 98 s | **1/2** | 2/2, 41 s |
+
+What this says, honestly:
+
+- **Agents without a shell are where bucketlens changes the outcome.** They can't open a
+  spreadsheet at all, and across many files they give up or spend many turns reading.
+- **Agents with a shell get the same answers either way.** bucketlens is about 2.5x faster for them
+  (no downloads; the 82 MB workbook alone took 20 to 65 s to download) and uses fewer tokens. It is
+  not cheaper: $0.23 and $0.30 across two runs, against $0.21, because tool results are fresh input
+  while a shell agent's long prompt is mostly cached.
+
+The answers were checked automatically against values taken from the files. The 2026 quarterly
+figures are newer than the model's training data, so they had to be read, not remembered.
+Details and earlier runs on synthetic data: [benchmarks/RESULTS.md](benchmarks/RESULTS.md).
+
+## Quick start
+
+bucketlens is an MCP server. Install it, point it at a bucket, and add it to any MCP client.
+
+```bash
+pip install bucketlens            # or: uv tool install bucketlens
+bucketlens setup                  # bucket + keys, typed hidden, saved to ~/.config/bucketlens/config.env
+bucketlens index                  # parse every PDF, XLSX and CSV once (optional; files are also indexed on first use)
+```
+
+**Claude Code**
+
+```bash
+claude mcp add bucketlens -- bucketlens serve
+```
+
+**Claude Desktop, Cursor, or any client that takes a JSON config** (no install needed with `uvx`):
+
+```json
+{
+  "mcpServers": {
+    "bucketlens": {
+      "command": "uvx",
+      "args": ["bucketlens", "serve"],
+      "env": {
+        "BUCKETLENS_R2_ACCOUNT_ID": "your Cloudflare account ID (or set BUCKETLENS_ENDPOINT for S3)",
+        "BUCKETLENS_BUCKET": "your-bucket",
+        "BUCKETLENS_ACCESS_KEY_ID": "...",
+        "BUCKETLENS_SECRET_ACCESS_KEY": "..."
+      }
+    }
+  }
+}
+```
+
+If you ran `bucketlens setup`, leave out `env`: the server reads the saved config.
+
+Works with Cloudflare R2, AWS S3, MinIO and other S3-compatible storage. Give it a key that can
+read the bucket and write under `.bucketlens/` (where the index lives). It is listed in the
+official MCP Registry as `io.github.Pritom14/bucketlens`.
+
+## Tools the agent gets
+
+| Tool | What it returns |
+|---|---|
+| `list_files(prefix)` | names, sizes, dates; nothing is downloaded |
+| `outline(path, depth)` | PDF: pages, table of contents with page numbers, token cost of reading it whole. Spreadsheet: sheets, rows, columns and types |
+| `search(path, text)` | pages of one PDF that contain the text, with snippets |
+| `search_all(text, folder, files_only)` | every PDF in a folder at once, as compact hits or just file names and counts |
+| `read_pages(path, pages)` | text of specific pages, e.g. `"36-38"` |
+| `query(path, sql)` | read-only SQL over a spreadsheet or CSV; each sheet is a table |
+| `read_rows(path, sheet, first, last)` | rows by the spreadsheet's own row numbers |
+
+## How it works
+
+The first time a file is touched (or when it's saved, with `watch`), bucketlens reads it once:
+
+- **PDF**: each page's text goes into one `pages.txt` with byte offsets, plus the outline. Reading
+  pages 600 to 602 of a 733-page PDF is then one range request (about 150 KB).
+- **XLSX / CSV**: each sheet becomes a Parquet file with a `_row` column. DuckDB reads only the
+  columns and row groups a query needs (rows 150,000 to 150,049 of a 20 MB workbook: about 190 KB).
+
+Everything is stored under `.bucketlens/index/<file>/<etag>/`. When a file changes its ETag
+changes, so an agent is never answered from an old version.
+
+Why not just read parts of the original file? We measured it: opening a PDF or the first rows of
+a workbook fetches 5 to 7% of the file, but deep pages and deep rows fetch 50 to 75%, because of
+how PDF and XLSX are laid out inside. Parsing once and serving slices is what makes every read
+small.
+
+## Keeping the index fresh
+
+```bash
+bucketlens watch              # Cloudflare R2: event notifications -> Queue, pulled over HTTP
+bucketlens watch --poll 300   # any S3: list the bucket every 5 minutes
+```
+
+With R2 event notifications, a new 492-page PDF was indexed 8.8 s after its upload started, an
+edited workbook 4.4 s after it was saved, and a deleted file's index removed 3 s later. To set it
+up: create a Queue, add an event notification on the bucket (object creation and deletion) that
+sends to it, and add a Cloudflare API token with **Account > Queues > Edit** to the config as
+`BUCKETLENS_CF_API_TOKEN`, with `BUCKETLENS_CF_QUEUE` set to the queue's name.
+
+## Costs
+
+bucketlens itself is free. On Cloudflare R2, the free tier (10 GB of storage, 1 million writes and
+10 million reads a month, free downloads) covered everything in the benchmarks. The index adds
+about 25% to stored bytes for these files. The watcher polls once a minute when idle, about
+1,440 Queue calls a day against a free allowance of 10,000. R2 has no hard spending cap, so set a
+billing alert.
+
+## Security
+
+- Keys stay on your machine, in a file only you can read. bucketlens never prints them.
+- SQL from agents is read-only: one statement, and DuckDB is locked so it can't read or write local
+  files or change its own settings.
+- The agent can read anything in the bucket the key can read. Use a key scoped to one bucket.
+
+## Limits
+
+- Reads PDF, XLSX/XLSM and CSV. Word and PowerPoint are next.
+- Scanned PDFs without a text layer aren't searchable yet (no OCR).
+- The first touch of a file reads it whole; use `watch` or `index` so agents never wait on it.
+- Benchmarks used one agent (Claude Code) and one model (Sonnet).
+
+## Reproduce the benchmarks
+
+See [benchmarks/README.md](benchmarks/README.md). The public files are fetched by a script, not
+stored in this repo.
+
+## License
+
+Apache-2.0

bucketlens-0.1.0/benchmarks/README.md

@@ -0,0 +1,25 @@
+# Benchmarks
+
+`agent_test.py` asks Claude Code the same questions three ways (shell + downloads, no shell +
+downloads, bucketlens only) and checks each answer against a value taken from the files.
+
+```bash
+pip install -e ".[dev]"
+bucketlens setup                      # point it at a test bucket
+python benchmarks/fetch_real.py       # downloads the public files and uploads them under real/
+bucketlens index --prefix real/
+python benchmarks/agent_test.py --questions benchmarks/questions/real.json --parallel 4
+```
+
+Each run is capped at `AGENT_TEST_BUDGET` dollars (default 0.40). The full real-file comparison
+(30 runs) cost about $1.
+
+- `questions/real.json`: 10 questions on Berkshire Hathaway reports, the World Bank WDI workbook and
+  100 CUAD contracts.
+- `questions/synthetic.json`: 17 questions on NIST SP 800-53 PDFs and generated spreadsheets and
+  contracts (`gen/`).
+- `results/`: every run, with answers, tokens, cost and time. `RESULTS.md` is the full log.
+
+Data sources: Berkshire Hathaway reports (berkshirehathaway.com), World Bank World Development
+Indicators (CC BY 4.0), CUAD v1 by The Atticus Project (CC BY 4.0). They are downloaded by the
+script, not stored here.