Skip to content

docs(bootstrap): point the module header at createSessionLifter - #193

Merged
chrischall merged 1 commit into
mainfrom
docs/bootstrap-module-header
Aug 3, 2026
Merged

docs(bootstrap): point the module header at createSessionLifter#193
chrischall merged 1 commit into
mainfrom
docs/bootstrap-module-header

Conversation

@chrischall

Copy link
Copy Markdown
Owner

Auto-review follow-up for #191.

The file-level comment still described the module as one-shot-only and never mentioned createSessionLifter — so the first thing a reader sees pointed at exactly the shape that PR set out to stop being the default.

Rewritten to lead with the choice: createSessionLifter for anything whose session can expire, bootstrap for genuinely one-shot callers (the user-invoked capture_session tool pattern). Includes the why, since the failure mode is what makes the default matter — capturing a value once is how an MCP ends up working for one credential lifetime and then dying with no way back.

Docs only; 1092 tests pass, typecheck clean.

Closes #192

Auto-review follow-up for #191. The file-level comment still described
the module as one-shot-only and never mentioned createSessionLifter,
which is now the recommended entry point — leaving the first thing a
reader sees pointing at the shape the PR set out to stop being the
default.

Closes #192

Co-Authored-By: Claude Opus 5 (1M context) <noreply@anthropic.com>
@chrischall chrischall added the documentation Improvements or additions to documentation label Aug 3, 2026
@github-actions github-actions Bot added the auto-review Trigger Claude + Copilot review on this PR label Aug 3, 2026
@claude

claude Bot commented Aug 3, 2026

Copy link
Copy Markdown

Claude finished @chrischall's task in 44s —— View job


Review: docs(bootstrap): point the module header at createSessionLifter

  • Analyzed PR context and CLAUDE.md conventions
  • Reviewed the documentation changes in detail
  • Verified alignment with project architecture and design
  • Confirmed tests pass and no code logic was modified

Findings

This documentation-only PR updates the module header comment in packages/bootstrap/src/index.ts to better reflect the actual API design choices introduced in #191.

What changed:

  • Removed "one-shot" from the module-level description to reflect that both bootstrap() and createSessionLifter() are now first-class entry points
  • Rewrote the header to lead with the architectural choice: createSessionLifter for repeatable lifts (expiring sessions), bootstrap for one-shot callers
  • Added clear motivation explaining the failure mode: capturing a session once is the most common way to build an MCP that works for one credential lifetime then silently fails with no recovery path

Quality assessment:

Correctness: The documentation accurately describes the API design. The module now explicitly teaches the right pattern first—renewable lifts for session managers—with the one-shot bootstrap() positioned as the escape hatch for genuinely one-shot use cases (user-invoked capture_session tool).

Adherence to conventions: Follows the project's guidance from CLAUDE.md: "Only add one [comment] when the WHY is non-obvious" — this header now explains both what the functions do and why the choice matters (the expiry dead-end failure mode).

Completeness: The createSessionLifter JSDoc (lines 220–272) already covers why renewables are better; this change makes the module landing-page comment point readers there first, closing the loop described in issue #192.

No breaking changes: Docs only; 1092 tests pass, typecheck clean. No code paths modified.


Verdict: pass

@github-actions

github-actions Bot commented Aug 3, 2026

Copy link
Copy Markdown
Contributor

✅ Auto-review verdict: pass — Documentation-only PR that correctly reframes the bootstrap module header to lead with createSessionLifter (for renewable sessions) over bootstrap() (for one-shot callers), with clear explanation of the failure modes that motivate the choice. Accurate, well-motivated, no issues.

@chrischall chrischall added the ready-to-merge Owner has reviewed; arm auto-merge to land when CI is green label Aug 3, 2026
@chrischall
chrischall enabled auto-merge (squash) August 3, 2026 01:23
@chrischall
chrischall merged commit 81334fa into main Aug 3, 2026
16 checks passed
@chrischall
chrischall deleted the docs/bootstrap-module-header branch August 3, 2026 01:23
chrischall added a commit that referenced this pull request Aug 3, 2026
🤖 I have created a release *beep* *boop*
---


##
[1.9.1](v1.9.0...v1.9.1)
(2026-08-03)


### Documentation

* **bootstrap:** point the module header at createSessionLifter
([#193](#193))
([81334fa](81334fa)),
closes [#192](#192)

---
This PR was generated with [Release
Please](https://github.com/googleapis/release-please). See
[documentation](https://github.com/googleapis/release-please#release-please).

---------

Co-authored-by: github-actions[bot] <41898282+github-actions[bot]@users.noreply.github.com>
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

auto-review Trigger Claude + Copilot review on this PR documentation Improvements or additions to documentation ready-to-merge Owner has reviewed; arm auto-merge to land when CI is green

Projects

None yet

Development

Successfully merging this pull request may close these issues.

Auto-review follow-ups for PR #191: feat(bootstrap): add createSessionLifter for renewable session lifts

1 participant