Skip to content

docs: rewrite FAQ for two-header auth pattern (v7)#270

Open
brmarketing wants to merge 1 commit into
NateBJones-Projects:mainfrom
brmarketing:main
Open

docs: rewrite FAQ for two-header auth pattern (v7)#270
brmarketing wants to merge 1 commit into
NateBJones-Projects:mainfrom
brmarketing:main

Conversation

@brmarketing

Copy link
Copy Markdown

Summary

  • URL-param auth (?key=) was removed in open-brain-mcp v7 (2026-05-04) for security — keys in URLs leak to server logs, browser history, and HTTP referer headers
  • Rewrites the setup section with a two-header pattern: Authorization: Bearer <SUPABASE_ANON_KEY> + x-brain-key: <OPEN_BRAIN_ACCESS_KEY>
  • Adds "Why two headers?" explanation (Supabase gateway layer vs app auth layer)
  • Adds concrete config examples for Claude Desktop, ChatGPT custom GPT, and Cursor/Claude Code
  • Adds deprecation note for users still on the old ?key= config
  • Updates Quick Reference item 3 to match

Test plan

  • Verify Claude Desktop example JSON parses correctly
  • Verify ChatGPT Action schema block is valid JSON
  • Verify .mcp.json block is valid JSON
  • Confirm no remaining ?key= references in the file

🤖 Generated with Claude Code

The URL-param auth pattern (?key=) was removed in open-brain-mcp v7
(2026-05-04) for security — URLs leak to logs, browser history, and
referer headers. New auth requires two headers:

- Authorization: Bearer <SUPABASE_ANON_KEY> (Supabase gateway JWT)
- x-brain-key: <OPEN_BRAIN_ACCESS_KEY> (app authentication)

This commit rewrites the setup section with concrete examples for
Claude Desktop, ChatGPT custom GPT, and Cursor/Claude Code, adds a
"Why two headers?" explanation, and includes a deprecation note for
existing users still on the URL-param config.

Co-Authored-By: Claude Opus 4.7 <noreply@anthropic.com>
@github-actions github-actions Bot added the documentation Improvements or additions to documentation label May 6, 2026
@github-actions

github-actions Bot commented May 6, 2026

Copy link
Copy Markdown

Hey @brmarketing — welcome to Open Brain Source! 👋

Thanks for submitting your first PR. The automated review will run shortly and check things like metadata, folder structure, and README completeness. If anything needs fixing, the review comment will tell you exactly what.

Once the automated checks pass, a human admin will review for quality and clarity. Expect a response within a few days.

If you have questions, check out CONTRIBUTING.md or open an issue.

@alanshurafa alanshurafa added review: needs-author-response Contributor response or clarification needed area: docs Review area: documentation alan-reviewed Reviewed by Alan Shurafa in Community Reviewer role labels May 20, 2026
@alanshurafa

Copy link
Copy Markdown
Collaborator

Thanks for the contribution, and welcome. The two-header explanation and the per-client config blocks (Claude Desktop, ChatGPT, Cursor) are useful additions.

One thing needs reconciling before this is ready. The PR states that URL-parameter auth (?key=) "was removed in v7" and that configs still using it "will receive a 401 after the v7 deploy." On the current main, server/index.ts (line 524) still reads:

const provided = c.req.header("x-brain-key") || new URL(c.req.url).searchParams.get("key");

with the comment "Accept access key via header OR URL query parameter." So ?key= is still accepted in the repo as it stands, and the FAQ would tell users their working setup is deprecated when it is not.

Could you point at where the v7 ?key= removal happens in this repo, or soften the migration note so it does not pre-announce a change that has not merged? Recommend author refresh once the doc lines up with the server.

— Alan (community reviewer; non-binding)

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

alan-reviewed Reviewed by Alan Shurafa in Community Reviewer role area: docs Review area: documentation documentation Improvements or additions to documentation review: needs-author-response Contributor response or clarification needed

Projects

None yet

Development

Successfully merging this pull request may close these issues.

2 participants