tomoshi 1.0.0 → 1.1.0

package/README.md

@@ -1,13 +1,57 @@
-# tomoshi (灯 — lamp light)
+<p align="center">
+  <img src="https://raw.githubusercontent.com/Michael-Obele/tomoshibi/main/banner.svg" alt="Tomoshibi — lamp light banner with paper lantern" width="100%" />
+</p>
 
-Self-hosted web search & scraping MCP for AI agents. One binary, $5/mo.
+<p align="center">
+  <a href="https://www.npmjs.com/package/tomoshi"><img src="https://img.shields.io/npm/v/tomoshi?label=tomoshi&color=cb0000" alt="npm version"/></a>
+  <a href="https://www.npmjs.com/package/tomoshi"><img src="https://img.shields.io/npm/dm/tomoshi" alt="npm downloads"/></a>
+  <a href="https://github.com/Michael-Obele/tomoshibi/actions/workflows/npm.yml"><img src="https://github.com/Michael-Obele/tomoshibi/actions/workflows/npm.yml/badge.svg" alt="npm provenance"/></a>
+  <a href="https://opensource.org/licenses/MIT"><img src="https://img.shields.io/badge/License-MIT-yellow.svg" alt="MIT"/></a>
+  <a href="https://github.com/Michael-Obele/tomoshibi"><img src="https://img.shields.io/github/stars/Michael-Obele/tomoshibi?style=social" alt="GitHub stars"/></a>
+</p>
 
-- **npm:** `tomoshi` (primary) + `tomoshibi` alias
-- **MCP:** 3 tools — `cinder_extract`, `cinder_discover`, `cinder_monitor`
+<h1 align="center">tomoshi <span style="font-weight:400">灯</span></h1>
 
-## Install
+<p align="center"><em>lamp light — the MCP that turns any site into LLM-ready markdown</em><br/>Self-hosted Firecrawl alternative. <strong>3 tools, not 17.</strong> One binary, $5/mo. Sigstore provenance.</p>
 
-```json
+<p align="center">
+  <a href="#install-30-seconds">Install</a> ·
+  <a href="#why-tomoshi">Why tomoshi</a> ·
+  <a href="#tools">Tools</a> ·
+  <a href="#hosting">Hosting</a>
+</p>
+
+---
+
+## Why tomoshi?
+
+If you're paying Firecrawl/Exa per token or spawning a browser per request, you're overpaying.
+
+| What hurts with hosted APIs | What tomoshi gives you | Outcome |
+|---|---|---|
+| **$0.01–0.10 per scrape** + rate limits | **$0 self-hosted** — one binary, hobby-tier RAM | Ship RAG without a cloud bill |
+| **500ms Chrome spawn per request** | **One shared allocator + recycled tabs** | ~200ms static, parallel pools |
+| **JS SPAs return empty HTML** | **Smart mode** — static first, fallback to Chromedp | Works on React/Vue without guessing |
+| **Noisy HTML (nav/ads/footer)** | **Readability main-content** + ad block | Clean markdown your LLM wants |
+
+Part of [**Tomoshibi 灯火**](https://github.com/Michael-Obele/tomoshibi) — Go API + Svelte 5 playground + this MCP. Formerly Cinder.
+
+---
+
+## Install (30 seconds)
+
+**Prerequisites:** A running Tomoshibi API. Host it in one command:
+
+```bash
+git clone https://github.com/Michael-Obele/tomoshibi.git && cd tomoshibi
+docker compose up -d  # api 7431 + redis 7434 + searxng 7435
+# or: fly deploy (see tomoshibi README)
+```
+
+Then add the MCP:
+
+```jsonc
+// .vscode/mcp.json or Claude config
 {
   "mcpServers": {
     "tomoshi": {
@@ -21,8 +65,54 @@ Self-hosted web search & scraping MCP for AI agents. One binary, $5/mo.
 }
 ```
 
-Legacy `CINDER_API_URL` still works.
+Legacy `CINDER_API_URL` still works. Aliases: `tomoshibi`, `tomoshibi-mcp` (same package).
+
+Restart your editor — `tomoshi` appears as 3 tools.
+
+---
+
+## Tools
+
+3 tools, not 8 — resource-oriented (`action` enum, ≤7 philosophy).
+
+| Tool | `action` | What it does |
+|---|---|---|
+| `tomoshi_extract` | `scrape` · `scrape_multi` (≤10) · `links` · `batch` · `batch_status` | Single/multi-page → markdown, link extraction, async batch (Redis) |
+| `tomoshi_discover` | `search` · `map` · `crawl` · `crawl_status` | SearXNG search (Brave fallback), sitemap, async BFS crawl |
+| `tomoshi_monitor` | `create` · `status` · `delete` | Hash markdown, webhook on change |
+
+Async actions (`batch`, `crawl`, `monitor`) are Redis-backed — poll `*_status` until done.
+
+**Example — scrape + search in one turn:**
+
+> `tomoshi_discover` `search` "svelte 5 runes" → `tomoshi_extract` `scrape_multi` on top 3 URLs → LLM-ready markdown
+
+---
+
+## Hosting
+
+| Option | Command | Cost |
+|---|---|---|
+| **Docker Compose** | `docker compose up -d` | $0 (your machine) |
+| **Fly.io** | `fly deploy` | ~$5/mo (512 MB) |
+| **From source** | `go run ./packages/api/cmd/api` | $0 + Chromium |
+
+API base: `http://localhost:7431` — all endpoints under `/v1` (`/scrape`, `/search`, `/crawl`, `/batch`, `/monitor`, `/map`).
+
+---
+
+## Links
+
+- **GitHub:** https://github.com/Michael-Obele/tomoshibi
+- **npm:** https://www.npmjs.com/package/tomoshi
+- **API docs:** `https://your-api.fly.dev/docs` (Swagger, auto-generated)
+
+---
+
+## Name
+
+**tomoshi** (灯 — ともし) — Japanese for *lamp, light*. Short form of **Tomoshibi** (灯火 — ともしび) *lamp light*, the glow of a paper lantern. Search as illumination: lighting up the web for AI agents.
 
-## Provenance
+## License
 
-Published with npm Provenance (OIDC). Verify at https://www.npmjs.com/package/tomoshi
+MIT — see [LICENSE](https://github.com/Michael-Obele/tomoshibi/blob/main/LICENSE).

package/dist/server.js

@@ -60,7 +60,7 @@ export function createServer() {
     // Resource: discovery — 1 tool per domain resource with `action` enum
     // Consolidates former cinder_search + cinder_map + cinder_crawl (3→1, crawl already merged start/status)
     server.tool({
-        name: "cinder_discover",
+        name: "tomoshi_discover",
         description: "Discovery resource (4 actions): `search` (SearXNG/Brave, domain filters/pagination), `map` (sitemap/traversal), `crawl` (enqueue BFS async, Redis), `crawl_status` (poll crawl). Replaces cinder_search/cinder_map/cinder_crawl.",
         schema: DiscoverSchema,
         annotations: {
@@ -72,7 +72,7 @@ export function createServer() {
     }, createDiscoverHandler(client));
     // Resource: change-tracking — already action-multiplexed (create|status|delete)
     server.tool({
-        name: "cinder_monitor",
+        name: "tomoshi_monitor",
         description: "Change-tracking resource (3 actions): `create` (hashes markdown, fires signed webhook on change), `status` (config/last hash/next check), `delete` (stop & remove). Requires Redis.",
         schema: MonitorSchema,
         annotations: {

package/dist/server.js.map

@@ -1 +1 @@
-{"version":3,"file":"server.js","sourceRoot":"","sources":["../src/server.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,SAAS,EAAE,MAAM,MAAM,CAAC;AACjC,OAAO,EAAE,wBAAwB,EAAE,MAAM,uBAAuB,CAAC;AACjE,OAAO,EAAE,SAAS,EAAE,MAAM,aAAa,CAAC;AAExC,MAAM,mBAAoB,SAAQ,wBAAwB;IACxD,KAAK,CAAC,YAAY,CAAC,MAAW;QAC5B,MAAM,CAAC,GAAQ,MAAM,KAAK,CAAC,YAAY,CAAC,MAAM,CAAC,CAAC;QAChD,IAAI,CAAC,CAAC,CAAC,IAAI,IAAI,CAAC,CAAC,CAAC,KAAK,IAAI,CAAC,CAAC,KAAK,CAAC;YAAE,CAAC,CAAC,IAAI,GAAG,QAAQ,CAAC;QACvD,OAAO,CAAC,CAAC;IACX,CAAC;CACF;AACD,OAAO,EAAE,YAAY,EAAE,MAAM,aAAa,CAAC;AAC3C,OAAO,EAAE,aAAa,EAAE,oBAAoB,EAAE,MAAM,oBAAoB,CAAC;AACzE,OAAO,EAAE,cAAc,EAAE,qBAAqB,EAAE,MAAM,qBAAqB,CAAC;AAC5E,OAAO,EAAE,aAAa,EAAE,oBAAoB,EAAE,MAAM,oBAAoB,CAAC;AAEzE;;;GAGG;AACH,MAAM,UAAU,YAAY;IAC1B,MAAM,MAAM,GAAG,SAAS,EAAE,CAAC;IAC3B,MAAM,MAAM,GAAG,IAAI,YAAY,EAAE,CAAC;IAElC,MAAM,MAAM,GAAG,IAAI,SAAS,CAC1B;QACE,IAAI,EAAE,MAAM,CAAC,eAAe;QAC5B,OAAO,EAAE,MAAM,CAAC,kBAAkB;QAClC,WAAW,EACT,uEAAuE;KAC1E,EACD;QACE,OAAO,EAAE,IAAI,mBAAmB,EAAE;QAClC,YAAY,EAAE;YACZ,KAAK,EAAE,EAAE,WAAW,EAAE,KAAK,EAAE;SAC9B;QACD,YAAY,EAAE;YACZ,4KAA4K;YAC5K,EAAE;YACF,+CAA+C;YAC/C,8NAA8N;YAC9N,6JAA6J;YAC7J,2FAA2F;YAC3F,EAAE;YACF,SAAS;YACT,qHAAqH;YACrH,yFAAyF;YACzF,yGAAyG;YACzG,uIAAuI;SACxI,CAAC,IAAI,CAAC,IAAI,CAAC;KACb,CACF,CAAC;IAEF,uGAAuG;IACvG,+GAA+G;IAC/G,MAAM,CAAC,IAAI,CACT;QACE,IAAI,EAAE,gBAAgB;QACtB,WAAW,EACT,uVAAuV;QACzV,MAAM,EAAE,aAAa;QACrB,WAAW,EAAE;YACX,YAAY,EAAE,KAAK;YACnB,aAAa,EAAE,IAAI;YACnB,cAAc,EAAE,KAAK;YACrB,eAAe,EAAE,KAAK;SACvB;KACF,EACD,oBAAoB,CAAC,MAAM,CAAQ,CACpC,CAAC;IAEF,sEAAsE;IACtE,yGAAyG;IACzG,MAAM,CAAC,IAAI,CACT;QACE,IAAI,EAAE,iBAAiB;QACvB,WAAW,EACT,kOAAkO;QACpO,MAAM,EAAE,cAAc;QACtB,WAAW,EAAE;YACX,YAAY,EAAE,KAAK;YACnB,aAAa,EAAE,IAAI;YACnB,cAAc,EAAE,KAAK;YACrB,eAAe,EAAE,KAAK;SACvB;KACF,EACD,qBAAqB,CAAC,MAAM,CAAQ,CACrC,CAAC;IAEF,gFAAgF;IAChF,MAAM,CAAC,IAAI,CACT;QACE,IAAI,EAAE,gBAAgB;QACtB,WAAW,EACT,qLAAqL;QACvL,MAAM,EAAE,aAAa;QACrB,WAAW,EAAE;YACX,YAAY,EAAE,KAAK;YACnB,aAAa,EAAE,IAAI;YACnB,cAAc,EAAE,KAAK;YACrB,eAAe,EAAE,KAAK;SACvB;KACF,EACD,oBAAoB,CAAC,MAAM,CAAQ,CACpC,CAAC;IAEF,OAAO,MAAM,CAAC;AAChB,CAAC"}
+{"version":3,"file":"server.js","sourceRoot":"","sources":["../src/server.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,SAAS,EAAE,MAAM,MAAM,CAAC;AACjC,OAAO,EAAE,wBAAwB,EAAE,MAAM,uBAAuB,CAAC;AACjE,OAAO,EAAE,SAAS,EAAE,MAAM,aAAa,CAAC;AAExC,MAAM,mBAAoB,SAAQ,wBAAwB;IACxD,KAAK,CAAC,YAAY,CAAC,MAAW;QAC5B,MAAM,CAAC,GAAQ,MAAM,KAAK,CAAC,YAAY,CAAC,MAAM,CAAC,CAAC;QAChD,IAAI,CAAC,CAAC,CAAC,IAAI,IAAI,CAAC,CAAC,CAAC,KAAK,IAAI,CAAC,CAAC,KAAK,CAAC;YAAE,CAAC,CAAC,IAAI,GAAG,QAAQ,CAAC;QACvD,OAAO,CAAC,CAAC;IACX,CAAC;CACF;AACD,OAAO,EAAE,YAAY,EAAE,MAAM,aAAa,CAAC;AAC3C,OAAO,EAAE,aAAa,EAAE,oBAAoB,EAAE,MAAM,oBAAoB,CAAC;AACzE,OAAO,EAAE,cAAc,EAAE,qBAAqB,EAAE,MAAM,qBAAqB,CAAC;AAC5E,OAAO,EAAE,aAAa,EAAE,oBAAoB,EAAE,MAAM,oBAAoB,CAAC;AAEzE;;;GAGG;AACH,MAAM,UAAU,YAAY;IAC1B,MAAM,MAAM,GAAG,SAAS,EAAE,CAAC;IAC3B,MAAM,MAAM,GAAG,IAAI,YAAY,EAAE,CAAC;IAElC,MAAM,MAAM,GAAG,IAAI,SAAS,CAC1B;QACE,IAAI,EAAE,MAAM,CAAC,eAAe;QAC5B,OAAO,EAAE,MAAM,CAAC,kBAAkB;QAClC,WAAW,EACT,uEAAuE;KAC1E,EACD;QACE,OAAO,EAAE,IAAI,mBAAmB,EAAE;QAClC,YAAY,EAAE;YACZ,KAAK,EAAE,EAAE,WAAW,EAAE,KAAK,EAAE;SAC9B;QACD,YAAY,EAAE;YACZ,4KAA4K;YAC5K,EAAE;YACF,+CAA+C;YAC/C,8NAA8N;YAC9N,6JAA6J;YAC7J,2FAA2F;YAC3F,EAAE;YACF,SAAS;YACT,qHAAqH;YACrH,yFAAyF;YACzF,yGAAyG;YACzG,uIAAuI;SACxI,CAAC,IAAI,CAAC,IAAI,CAAC;KACb,CACF,CAAC;IAEF,uGAAuG;IACvG,+GAA+G;IAC/G,MAAM,CAAC,IAAI,CACT;QACE,IAAI,EAAE,gBAAgB;QACtB,WAAW,EACT,uVAAuV;QACzV,MAAM,EAAE,aAAa;QACrB,WAAW,EAAE;YACX,YAAY,EAAE,KAAK;YACnB,aAAa,EAAE,IAAI;YACnB,cAAc,EAAE,KAAK;YACrB,eAAe,EAAE,KAAK;SACvB;KACF,EACD,oBAAoB,CAAC,MAAM,CAAQ,CACpC,CAAC;IAEF,sEAAsE;IACtE,yGAAyG;IACzG,MAAM,CAAC,IAAI,CACT;QACE,IAAI,EAAE,kBAAkB;QACxB,WAAW,EACT,kOAAkO;QACpO,MAAM,EAAE,cAAc;QACtB,WAAW,EAAE;YACX,YAAY,EAAE,KAAK;YACnB,aAAa,EAAE,IAAI;YACnB,cAAc,EAAE,KAAK;YACrB,eAAe,EAAE,KAAK;SACvB;KACF,EACD,qBAAqB,CAAC,MAAM,CAAQ,CACrC,CAAC;IAEF,gFAAgF;IAChF,MAAM,CAAC,IAAI,CACT;QACE,IAAI,EAAE,iBAAiB;QACvB,WAAW,EACT,qLAAqL;QACvL,MAAM,EAAE,aAAa;QACrB,WAAW,EAAE;YACX,YAAY,EAAE,KAAK;YACnB,aAAa,EAAE,IAAI;YACnB,cAAc,EAAE,KAAK;YACrB,eAAe,EAAE,KAAK;SACvB;KACF,EACD,oBAAoB,CAAC,MAAM,CAAQ,CACpC,CAAC;IAEF,OAAO,MAAM,CAAC;AAChB,CAAC"}

package/dist/tools/discover.js

@@ -2,7 +2,7 @@ import * as v from "valibot";
 /**
  * Resource-oriented multiplexed discovery tool.
  * Consolidates `cinder_search` + `cinder_map` + `cinder_crawl`
- * into a single `cinder_discover` resource (3→1).
+ * into a single `tomoshi_discover` resource (3→1).
  *
  * Principle: 1 tool per domain resource with `action` enum
  * (arch.md "Why 7 Tools Instead of 17" — FlarelyLegal 17→7).

package/dist/tools/extract.js

@@ -2,7 +2,7 @@ import * as v from "valibot";
 /**
  * Resource-oriented multiplexed extraction tool.
  * Consolidates `cinder_scrape` + `cinder_links` + `cinder_batch_scrape`
- * into a single `cinder_extract` resource (5→1 with scrape_multi).
+ * into a single `tomoshi_extract` resource (5→1 with scrape_multi).
  *
  * Principle: 1 tool per domain resource with `action` enum
  * (arch.md "Why 7 Tools Instead of 17" — FlarelyLegal 17→7).

package/dist/tools/monitor.js

@@ -1,6 +1,6 @@
 import * as v from "valibot";
 /**
- * Schema for the cinder_monitor tool.
+ * Schema for the tomoshi_monitor tool.
  * A single tool that creates, checks, or deletes a change-tracking monitor,
  * selected by the `action` discriminator (mirrors handlers.MonitorRequest).
  */

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "tomoshi",
-  "version": "1.0.0",
+  "version": "1.1.0",
   "description": "Tomoshibi (灯火 — lamp light) — self-hosted web search & scraping for AI agents. One binary, $5/mo.",
   "bin": {
     "tomoshi": "dist/stdio.js",
@@ -10,7 +10,11 @@
   "type": "module",
   "main": "dist/index.js",
   "types": "dist/index.d.ts",
-  "files": ["dist", "README.md", "LICENSE"],
+  "files": [
+    "dist",
+    "README.md",
+    "LICENSE"
+  ],
   "publishConfig": {
     "access": "public",
     "provenance": true
@@ -25,6 +29,15 @@
     "patch:tmcp": "echo \"no patch needed\"",
     "postinstall": "echo \"no patch needed\""
   },
+  "repository": {
+    "type": "git",
+    "url": "git+https://github.com/Michael-Obele/tomoshibi.git",
+    "directory": "packages/mcp"
+  },
+  "homepage": "https://github.com/Michael-Obele/tomoshibi#readme",
+  "bugs": {
+    "url": "https://github.com/Michael-Obele/tomoshibi/issues"
+  },
   "keywords": [
     "tmcp",
     "mcp",