Skip to content

docs: mark hosted members experimental, with how to keep one safe - #2189

Merged
mvschwarz merged 1 commit into
mainfrom
dd/hosted-experimental-box
Oct 27, 2026
Merged

mvschwarz merged 1 commit into
mainfrom
dd/hosted-experimental-box

Conversation

@mvschwarz

@mvschwarz mvschwarz commented Oct 27, 2026 •

Copy link
Copy Markdown
Owner

Adds a short note and a box at the top of docs/reference/hosted-members.md, before "Set one up". They say that serving rig mcp serve --http on the internet is experimental, unsupported and off by default. The box explains what doing it opens up, and how to keep the token and grant narrow and revoke them. Text only.

🤖 Generated with Claude Code

Summary by CodeRabbit

  • Documentation
    • Clarified that locally connected assistants can reach the MCP server directly, while cloud-hosted assistants need an internet-reachable server.
    • Documented the experimental, unsupported setup requirements for internet access, including HTTP serving, a TLS tunnel or proxy, and a token.
    • Added guidance to treat tokens like passwords, limit their permissions, and revoke them when access is no longer needed.

@coderabbitai

coderabbitai Bot commented Oct 27, 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: ec966e29-15c1-488d-86d8-863947184114
Commits

Reviewing files that changed from the base of the PR and between 4ee8bdc and 4859213.

Files selected for processing: 1
  • docs/reference/hosted-members.md

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

Walkthrough

The hosted-members documentation now distinguishes local and cloud assistant connectivity. It warns that internet exposure is experimental and unsupported, and describes server setup and token-handling precautions.

Changes: Hosted-member documentation

Layer / File(s) Summary
Internet exposure and token guidance
docs/reference/hosted-members.md
The page explains that cloud assistants require internet access to reach the MCP server. It states that the server does not listen on the internet by default and describes the required HTTP, TLS tunnel or proxy, and token setup. It also advises limiting, protecting, and revoking tokens.

Priority: Normal

Estimated code review effort: 1 (Trivial) | ~3 minutes

Change: Other

Possibly related PRs

  • mvschwarz/openrig#2127: Documents hosted-member HTTP deployment and the proxy path discussed by this change.
  • mvschwarz/openrig#2095: Introduces hosted members through the HTTP server and revocable bearer grants covered by the warning.
  • mvschwarz/openrig#1872: Documents HTTP MCP access, TLS, and token grants for assistants that cannot connect locally.

Suggested reviewers: openrig-review

Merge Risk: Minimal · up to 48592

No merge-blocking issues were identified.

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 "docs: mark hosted members experimental, with how to keep one safe" matches the changeset. The PR adds a note and warning box to docs/reference/hosted-members.md that marks internet-reachabl…
Docstring Coverage Passed No eligible functions found in the changed files. Skipping docstring coverage check. Docstring coverage is scoped to functions touched by this diff. Documentation-only edits and deletions within survi…
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: Title check

Explanation

The title "docs: mark hosted members experimental, with how to keep one safe" matches the changeset. The PR adds a note and warning box to docs/reference/hosted-members.md that marks internet-reachable MCP serving as experimental and unsupported, and it gives token and grant guidance. The title names the main change (experimental marking) and the secondary content (safety guidance), so it is related to the changeset. The phrase "keep one safe" is slightly informal, and the title does not name the local versus cloud-hosted distinction, but that is acceptable for a title.

Full details: Docstring Coverage

Explanation

No eligible functions found in the changed files. Skipping docstring coverage check. Docstring coverage is scoped to functions touched by this diff. Documentation-only edits and deletions within surviving functions are included; unchanged diff context and fully deleted functions are excluded. Analyzed 0 functions across 0 files. (1 skipped: 1 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

Thanks for using CodeRabbit! It's free for OSS, and your support helps us grow. If you like it, consider giving us a shout-out.

❤️ Share

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

@openrig-review openrig-review left a comment

Copy link
Copy Markdown
Collaborator

Choose a reason for hiding this comment

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

Approved at 4859213. The hosted-members reference now opens with a note that remote hosted members are experimental, unsupported and off by default, and that serving rig mcp serve --http on the internet behind your own tunnel is like opening a port, with the token treated like a password, the narrowest grant and rig mcp token revoke when done. An independent source review is clear at this head. Required CI passes at this head.

@mvschwarz
mvschwarz merged commit 4f1d031 into main Oct 27, 2026
15 checks passed
@mvschwarz
mvschwarz deleted the dd/hosted-experimental-box branch October 27, 2026 17:11
@mvschwarz mvschwarz moved this to Done in OpenRig roadmap Oct 27, 2026
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

Status: Done

Development

Successfully merging this pull request may close these issues.

2 participants