Skip to content

docs(ruby-gem): sync gem 0.27.0 contracts (MCP, capture, Botasaurus) - #1238

Merged
gildesmarais merged 8 commits into
mainfrom
feat/mcp-agent-ux
Aug 19, 2026
Merged

docs(ruby-gem): sync gem 0.27.0 contracts (MCP, capture, Botasaurus)#1238
gildesmarais merged 8 commits into
mainfrom
feat/mcp-agent-ux

Conversation

@gildesmarais

@gildesmarais gildesmarais commented Aug 17, 2026

Copy link
Copy Markdown
Member

What changed

  • Forward-facing ruby-gem docs match gem 0.27.0 on master: MCP envelope, AutoFallback on scrape/capture, capture enhance-only output, --explain, Botasaurus OpenAPI 2.0, admission telemetry.
  • Breaking renames and integrator migrations are scoped to Backward Compatibility §0.27.0.
  • UAT feedback: removed repeated “what changed / do not use X” prose from guides and reference pages.

Why

#463#471 and botasaurus-scrape-api#37 merged to default. The next gem release is 0.27.0. Docs that taught obsolete MCP _meta, Faraday-only auto, or scroll_to_bottom sent readers down dead paths.

Risk

  • Low — docs only. Source of truth is html2rss master (tagged 0.26.0 today; these contracts ship in 0.27.0).

Review map

Review map: start at backward-compatibility.mdx §0.27.0, then mcp-server.mdx and strategy.mdx.

Validation

Document YAML capture, apply's zero-item ship gate, inspect recon, and mcp.json Botasaurus env so agents stop teaching Faraday-only auto.
Point MCP guides at ok/next_step/guidance/payload so agents stop reading _meta or a raw items array.
Cleanup owns feed-item admission; enhance fills missing card fields and drops listing chrome. Status.admission_drops and auto_feed_result/--explain expose the same telemetry.
Capture stamps strategy and supports --explain; MCP daemons log to stderr at info. Replace scroll_to_bottom with scroll and document the OpenAPI 2.0 window_size object.
…ions

auto/capture --explain print telemetry on stderr. MCP inspect payload includes admission and XHR recon. request.botasaurus matches the scrape-API contract (no extra keys, window_size object).
…alidation

Faraday decodes unlabeled gzip/brotli and sniffs HTML bodies. Invalid Botasaurus keys (scroll_to_bottom, array window_size) fail validation; --explain surfaces admission drops.
Capture envelopes include optional segment/strategy/admission fields. Zero-item apply points agents at inspect_url.
@gildesmarais gildesmarais changed the title docs(ruby-gem): document MCP envelope results docs(ruby-gem): sync MCP envelope and post-0.26 gem contracts Aug 18, 2026
Forward-facing guides teach present MCP and capture behavior; breaking contract changes live under backward-compatibility §0.27.0. Fixes inspect_url auto staying on Faraday in MCP prompts.
@gildesmarais gildesmarais changed the title docs(ruby-gem): sync MCP envelope and post-0.26 gem contracts docs(ruby-gem): sync gem 0.27.0 contracts (MCP, capture, Botasaurus) Aug 19, 2026
@gildesmarais
gildesmarais merged commit 837bde8 into main Aug 19, 2026
5 checks passed
@gildesmarais
gildesmarais deleted the feat/mcp-agent-ux branch August 19, 2026 14:40
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

1 participant