docs: sync maintainer docs, README, and reserved-code comments with code#22
Merged
Merged
Conversation
- docs/: add the maintainer docs tree (architecture, configuration, deployment, security + index), verified against the code at HEAD 529e6c6 - CLAUDE.md: replace drifted src/config.ts line refs (:97/:66/:107) with stable symbol references; add docs/ pointers and the HTTP auth env vars - README.md: document BRAVE_MCP_AUTH_TOKEN / ALLOWED_HOSTS / ALLOWED_ORIGINS, the image_search v2 response change, and link the docs/ tree - src/{utils,constants,helpers}.ts: mark checkRateLimit, RATE_LIMIT, and registerSigIntHandler as reserved / not wired up
|
You have reached your Codex usage limits for code reviews. You can see your limits in the Codex usage dashboard. |
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
1 participant
Add this suggestion to a batch that can be applied as a single commit.This suggestion is invalid because no changes were made to the code.Suggestions cannot be applied while the pull request is closed.Suggestions cannot be applied while viewing a subset of changes.Only one suggestion per line can be applied in a batch.Add this suggestion to a batch that can be applied as a single commit.Applying suggestions on deleted lines is not supported.You must change the existing code in this line in order to create a valid suggestion.Outdated suggestions cannot be applied.This suggestion has been applied or marked resolved.Suggestions cannot be applied from pending reviews.Suggestions cannot be applied on multi-line comments.Suggestions cannot be applied while the pull request is queued to merge.Suggestion cannot be applied right now. Please check back later.
Summary
Sync the maintainer documentation, README, and reserved-code comments with the current code at HEAD 529e6c6, and add the new docs/ tree.
Related
Updates
src/config.tsline refs (:97/:66/:107)checkRateLimit,RATE_LIMIT,registerSigIntHandlerDetails
Sync docs and comments with code
docs/README.mdrecords the source-of-truth policy (code wins; re-derive fromsrc/config.ts)file.ts:Nline refs from CLAUDE.md in favor of symbol references; precision fixes indocs/architecture.md(all three Brave request headers,/mcpisapp.all, the realBrave Search API request failed:throw prefix) anddocs/security.mddocs/accuracy vssrc/{config,worker,worker-auth,protocols,BraveAPI}; the three reserved-code commentsTesting
npm run format:check-- passnpm run lint-- 0 errors (8 pre-existing upstream warnings)npm run build-- passScreenshots / Notes
Breaking changes
Risks and rollout
Checklist