Skip to content

Offer a local mailbox demo before connecting an agent - #1

Merged
okgrit merged 2 commits into
mainfrom
docs/first-local-demo
Oct 22, 2026
Merged

okgrit merged 2 commits into
mainfrom
docs/first-local-demo

Conversation

@okgrit

@okgrit okgrit commented Oct 22, 2026 •

Copy link
Copy Markdown
Owner

The quickstart's uvx alternative assumes an unstated cloned checkout, and trying a message/response currently leads directly into native agent setup. Clarify the checkout requirement and link a separate-venv/manual loopback demo that can be tried before connecting either agent.

Use reply text before --by in the new walkthrough and the existing claim-holder example. The alternative order works in the recorded Windows Python 3.12.14 rehearsal but fails an equivalent parser on Python 3.12.3. The documented order parsed in both probes and passed a fresh isolated source-level send/claim/reply/wait/readback smoke.

Validation: reproduced uvx --from . failure in a fresh non-project directory; checked targeted Markdown destinations, GitHub Markdown rendering/heading consistency and whitespace. Independent copy review and correction rereview found no blockers. The earlier pinned public-source Windows rehearsal included 90 selected tests; native dot/Claude and remote HTTPS acceptance remain unverified.

Documentation only; existing agent setup and artwork are retained.

Summary by CodeRabbit

  • Documentation
    • Added a Windows PowerShell walkthrough for exchanging synthetic messages through an isolated local mailbox, including setup, sending and claiming a message, replying, and reading the reply.
    • Added guidance on mailbox isolation, token and plaintext-data precautions, demo limitations, cleanup, and reporting issues.
    • Clarified that the uvx --from . Quickstart option requires an existing clone and must be run from its root.
    • Updated the documented dotline reply syntax to place --by <session_id> before the answer text.

Copilot AI balanced review requested due to automatic review settings October 22, 2026 20:02
@coderabbitai

coderabbitai Bot commented Oct 22, 2026 •

Copy link
Copy Markdown

Review in Change Stack →

No actionable comments were generated in the recent review. 🎉

ℹ️ Recent review info
⚙️ Run configuration
  • Source mode: Auto
  • Repository: Unavailable
  • Branch: Unavailable
  • File: No configuration file from this repository applied
  • Commit: Unavailable
  • Layers: defaults
  • Review profile: CHILL
  • Plan: Advanced
  • Run ID: 7ea8a5c7-b48a-49ad-9580-89bec13a4d2c
📥 Commits

Reviewing files that changed from the base of the PR and between 8f8a0fc and 0fd4d1f.

📒 Files selected for processing: 2
  • README.md
  • docs/LOCAL-DEMO.md

Included review availability: This review used your included allowance. Your plan provides up to 10 included reviews per hour; 8 remain after this review.

📝 Walkthrough

The README links to a local mailbox demo, clarifies Quickstart command usage, and updates the documented reply syntax. A new PowerShell guide describes isolated mailbox setup, a synthetic message exchange, and cleanup.

Changes: Local mailbox demo

Layer / File(s) Summary
Demo scope and setup
README.md, docs/LOCAL-DEMO.md
The README introduces the isolated demo and states that the uvx alternative applies from the cloned repository root. The guide covers prerequisites, environment setup, mailbox configuration, and server startup.
Mailbox exchange and cleanup
README.md, docs/LOCAL-DEMO.md
The guide covers health checks, sending and replying to a synthetic message, reading replies, and cleanup. It records demo limitations, precautions, and reporting guidance. The README places --by <session_id> before the reply text.

Priority: ⬇️ Low

Estimated code review effort: 2 (Simple) | ~8 minutes

Change: Other

Merge Risk: ⚪ Minimal · up to 0fd4d

This documentation-only change presents no merge-blocking risk.

Architecture risk: 🔵 Low · up to 0fd4d

The change affects 2 systems.

Changed systems: docs, README.md

Architecture concerns
No architecture-level concerns identified.

Review details

Systems and components

  • observed — docs (service) was modified; 1 changed file maps to changed impact.
  • observed — README.md (service) was modified; 1 changed file maps to changed impact.

Before / after behavior

  • observed — Modified behavior in README.md: Adds a local-demo link and describes an isolated PowerShell walkthrough using a separate virtual environment and loopback mailbox; the reply is supplied manually, and the walkthrough tests the protocol rather than native agent integration.
  • observed — Modified behavior in README.md: Clarifies that uvx --from . dotline ... is the non-persistent alternative when run from the cloned repository’s root, and that it replaces dotline ... throughout the guide.
  • observed — Modified behavior in README.md: Changes the documented reply syntax so --by <session_id> precedes the answer text.
  • observed — Modified behavior in docs/LOCAL-DEMO.md: Adds the demo’s scope and prerequisites, then gives commands to create a virtual environment, install a pinned source revision, configure an isolated mailbox and loopback URL, initialize it, and start the server. Notes that installation may download build tooling, the token contents should not be shared, and the server binds to loopback.
Pre-merge checks: Passed 5
Check name Status Explanation
Description Check Passed Check skipped - CodeRabbit’s high-level summary is enabled.
Title check Passed The title clearly describes the main change: adding a local mailbox demo that users can run before connecting an agent.
Docstring Coverage Passed No functions found in the changed files to evaluate docstring coverage. Skipping docstring coverage check. Docstring coverage is scoped to functions touched by this diff. Analyzed 0 functions across 0…
Linked Issues check Passed Check skipped because no linked issues were found for this pull request.
Out of Scope Changes check Passed Check skipped because no linked issues were found for this pull request.
Full details: Docstring Coverage

Explanation

No functions found in the changed files to evaluate docstring coverage. Skipping docstring coverage check. Docstring coverage is scoped to functions touched by this diff. Analyzed 0 functions across 0 files. (2 skipped: 2 unsupported.)

✨ Finishing Touches
🧪 Generate unit tests (beta)
  • Commit to this branch
  • Create a new PR
  • Autofix · Keep fixing CodeRabbit findings and required CI, and resolving merge conflicts

Comment @coderabbitai help to get the list of available commands.

Copilot AI left a comment

Copy link
Copy Markdown

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

🟡 Changes recommended

The documented reply command fails argument parsing, preventing the walkthrough from completing successfully.

1 open issue
What changed in this PR

This documentation-only PR adds a local mailbox demo before native agent setup and clarifies the checkout requirement for the quickstart’s uvx alternative.

Changes:

  • Add a PowerShell walkthrough using an isolated virtual environment and loopback mailbox.
  • Explain manual send, claim, reply, readback, cleanup, and validation limits.
  • Clarify that uvx --from . must run from a cloned repository’s root.
File Description
README.md Links the local demo and clarifies the uvx checkout requirement.
docs/​LOCAL-DEMO.md Documents the isolated manual mailbox demo and its security and integration limits.

Review effort: Balanced

Comment thread docs/LOCAL-DEMO.md Resolved
@okgrit
okgrit merged commit ca33726 into main Oct 22, 2026
16 checks passed
@okgrit
okgrit deleted the docs/first-local-demo branch October 22, 2026 20:28
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.

2 participants