Skip to content

Link the approver's own page from the README's MCP row - #221

Merged
rohanrkamath merged 1 commit into
mainfrom
readme-link-approver-page
Sep 15, 2026
Merged

rohanrkamath merged 1 commit into
mainfrom
readme-link-approver-page

Conversation

@arpanghoshal

@arpanghoshal arpanghoshal commented Sep 15, 2026

Copy link
Copy Markdown
Member

One link. The Agents and MCP row of the documentation table lists MCP overview and The gateway in five minutes, and omits Approve from your assistant, which is the page telling the person who has to answer how to do it without a checkout.

Why this one is worth a PR

The README sells the approve decision harder than anything else in it. The demo turns on it, and the three-step walkthrough stops a €5,000 refund and waits for a person. Then the only way it ever shows a human answering is ctrlrun approve at a shell.

A reader evaluating this for a team asks whether their finance person needs a terminal and a checkout. The honest answer is no: there is a webhook, there are framework interrupts, and since SPEC-mcp-operator there is a server with eight tools. The README cannot currently tell them any of that. ctrlrun mcp-operator appears in this file exactly once, inside the mcp-name: comment added for the registry, which is to say not at all.

What it is not

Not a new section, and not a row in Three ways to use it. That table is the enforcement path, and §1.1 is emphatic that the two never meet: "ctrlrun gateway is in the agent's path; this is in the approver's path, and the two never meet." A fourth row there would blur a distinction the spec works to keep. The documentation table is where a reader already goes looking for the next page, so the gap belongs to it.

The link points at docs.ctrlrun.dev rather than the site, which is the rule test_readme_assets.py states for every documentation link in this file. Both URLs were checked live and return 200.

Checks

scripts/check.sh: ruff format, ruff check, mypy --strict, 4128 passed, 317 skipped. Header copy pins and the badge row are untouched.

Summary by CodeRabbit

  • Documentation
    • Updated the documentation table with links for approving actions from an assistant and using the MCP gateway approval workflow.

@coderabbitai

coderabbitai Bot commented Sep 15, 2026

Copy link
Copy Markdown

Review Change StackReview Change Stack

No actionable comments were generated in the recent review. 🎉

ℹ️ Recent review info
⚙️ Run configuration

Configuration used: defaults

Review profile: CHILL

Plan: Advanced

Run ID: 691b12c8-96cf-4600-b0a1-17072d1ad016

📥 Commits

Reviewing files that changed from the base of the PR and between 55ed9ec and 29ca854.

📒 Files selected for processing (1)
  • README.md

Included review availability: Your plan provides up to 10 included reviews per hour; 7 remain after this review.


📝 Walkthrough

Walkthrough

The README documentation table now links to the “Approve from your assistant” workflow in the “Agents and MCP” row.

Changes

Documentation update

Layer / File(s) Summary
Agents and MCP documentation links
README.md
The “Agents and MCP” row now includes an “Approve from your assistant” link.

Priority: ⬇️ Low

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

Change: Other

Merge Risk: ⚪ Minimal · up to 87bc6

The change only adds an approval workflow link to the README and is mergeable.

🚥 Pre-merge checks | ✅ 5
✅ Passed checks (5 passed)
Check name Status Explanation
Description Check ✅ Passed Check skipped - CodeRabbit’s high-level summary is enabled.
Title check ✅ Passed The title clearly and concisely describes the main documentation change: adding the approver page link to the README MCP row.
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.
✨ Finishing Touches
🧪 Generate unit tests (beta)
  • Create PR with unit tests
  • Commit unit tests in branch readme-link-approver-page

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

Signed-off-by: arpan <contact@arpanghoshal.com>
@arpanghoshal
arpanghoshal force-pushed the readme-link-approver-page branch from 29ca854 to 87bc677 Compare September 15, 2026 18:49
@rohanrkamath
rohanrkamath merged commit 7d5c7a2 into main Sep 15, 2026
16 checks passed
@rohanrkamath
rohanrkamath deleted the readme-link-approver-page branch September 15, 2026 19:02
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