feat: restructure mcp auth docs into dedicated section and add per-user headers auth type#3707
feat: restructure mcp auth docs into dedicated section and add per-user headers auth type#3707Pratham-Mishra04 wants to merge 1 commit into
Conversation
|
Warning Review limit reached
Your plan currently allows 4 reviews/hour. Refill in 14 minutes and 12 seconds. Your organization has run out of usage credits. Purchase more in the billing tab. ⌛ How to resolve this issue?After more review capacity refills, a review can be triggered using the We recommend that you space out your commits to avoid hitting the rate limit. 🚦 How do rate limits work?CodeRabbit enforces hourly rate limits for each developer per organization. Our paid plans have higher rate limits than trial, open-source, and free plans. In all cases, review capacity refills continuously over time. Please see our FAQ for further information. ℹ️ Review info⚙️ Run configurationConfiguration used: Organization UI Review profile: CHILL Plan: Pro Run ID: 📒 Files selected for processing (18)
✨ Finishing Touches🧪 Generate unit tests (beta)
Comment |
|
|
|
Warning This pull request is not mergeable via GitHub because a downstack PR is open. Once all requirements are satisfied, merge this PR as a stack on Graphite.
This stack of pull requests is managed by Graphite. Learn more about stacking. |
Pratham-Mishra04
changed the base branch from
05-21-docs_adds_per_user_mcp_connection_docs
to
graphite-base/3707
Confidence Score: 4/5Documentation-only change; no code paths affected. All redirects are correctly mapped and internal cross-references resolve. The restructure is thorough and internally consistent. One sentence in none.mdx says auth_type is immutable while implying it can be changed in place, which is misleading. The sessions reconciliation table has an ambiguous 'same as the inverse' row. Both are minor clarity issues with no functional impact. docs/mcp/auth/none.mdx (contradictory immutability wording) and docs/mcp/sessions.mdx (ambiguous reconciliation table row). Important Files Changed
Reviews (1): Last reviewed commit: "docs: mcp docs update" | Re-trigger Greptile |
![greptile-apps[bot]](https://avatars.githubusercontent.com/in/867647?s=60&v=4){kind=small}
| | Toggle MCP `AllowOnAllVirtualKeys` **on** | Orphaned rows whose only access path was this implicit grant flip back to `active` | | ||
| | Remove a VK from the MCP's `vk_configs` | (VK, MCP) credentials flip to `orphaned` (unless the VK also has implicit access) | | ||
| | Add a VK to the MCP's `vk_configs` | Orphaned (VK, MCP) credentials flip back to `active` | | ||
| | Remove an MCP from a VK's `mcp_configs` | Same as the inverse — (VK, MCP) credentials orphan | |
There was a problem hiding this comment.
| | Remove an MCP from a VK's `mcp_configs` | Same as the inverse — (VK, MCP) credentials orphan | | |
| | Remove an MCP from a VK's `mcp_configs` | (VK, MCP) credentials flip to `orphaned` (unless the VK also has implicit access via `AllowOnAllVirtualKeys`) | |
Note: If this suggestion doesn't match your team's coding style, reply to this and let me know. I'll remember it for next time!
| <Tab title="API"> | ||
|
|
||
| ```bash | ||
| curl -X POST http://localhost:8080/api/mcp/client \ |
There was a problem hiding this comment.
The parenthetical says connection_type and auth_type are immutable after creation, then immediately says they "can be edited later if you delete and re-create." Readers will infer there is an in-place edit path. Consider rephrasing: "…immutable after creation — to change auth_type later you must delete and re-create the MCP client."
2 participants
Summary
Restructures the MCP authentication documentation into a dedicated
mcp/auth/section with individual pages per auth type, renamesgateway-urltogateway, and adds two new auth type pages (headersandper-user-headers) that were previously undocumented.Changes
mcp/gateway-url.mdx→mcp/gateway.mdxand updated the title to "Bifrost as an MCP Gateway"; added redirects from old URLsmcp/oauth.mdxandmcp/per-user-oauth.mdxintomcp/auth/oauth.mdxandmcp/auth/per-user-oauth.mdxwith redirects from old pathsmcp/auth/overview.mdx,mcp/auth/none.mdx,mcp/auth/headers.mdx, andmcp/auth/per-user-headers.mdxoauthandper-user-oauthentriesmcp/connecting-to-servers.mdxto remove inline auth configuration examples and point to the new auth section insteadmcp/sessions.mdxto cover both OAuth token rows and per-user header credential rows, added a reconciliation table for VK/MCP access changes, and expanded troubleshootingmcp/gateway.mdxto document per-user headers alongside per-user OAuth in the gateway auth section, and added a new "Disable auto tool injection" section with UI/API/config.json tabsoverview.mdx,cli-agents/, andmcp/code-mode.mdxto point to the new pathsType of change
Affected areas
How to test
Verify all internal doc links resolve correctly, particularly:
/mcp/auth/overview,/mcp/auth/none,/mcp/auth/headers,/mcp/auth/oauth,/mcp/auth/per-user-oauth,/mcp/auth/per-user-headers/mcp/gateway(and that/mcp/gateway-urland/features/mcp/gateway-urlredirect correctly)/mcp/oauthand/mcp/per-user-oauthredirect to their new pathsBreaking changes
The pages
/mcp/gateway-url,/mcp/oauth, and/mcp/per-user-oauthhave moved. Redirects are in place indocs.json, but any external links pointing to the old URLs will follow the redirect rather than land directly.Related issues
Security considerations
No security implications. Documentation only.
Checklist
docs/contributing/README.mdand followed the guidelines