docs: reconcile documentation with implementation (9 discrepancies)#6686
Merged
Conversation
Fix 9 discrepancies identified in nightly reconciliation report: Critical: - README.md: Add Authentication section with GitHub token priority order (GITHUB_MCP_SERVER_TOKEN > GITHUB_TOKEN > GITHUB_PERSONAL_ACCESS_TOKEN > GH_TOKEN) - README.md: Add Tracing section with OTEL_EXPORTER_OTLP_ENDPOINT, OTEL_EXPORTER_OTLP_HEADERS, OTEL_SERVICE_NAME env var references - README.md: Broaden line ~62 pointer to docs/ENVIRONMENT_VARIABLES.md from 'containerized-only' to 'complete reference for all env vars' Important: - README.md: Add Gateway Configuration section with trusted_bots field table - AGENTS.md: Add note in Config Examples pointing to docs/CONFIGURATION.md for full field list including trusted_bots, rate_limit_threshold, rate_limit_cooldown - docs/ENVIRONMENT_VARIABLES.md: Add TAVILY_API_KEY under Test/Development Overrides - docs/ENVIRONMENT_VARIABLES.md: Update Containerized Deployment Variables to note that both run.sh and run_containerized.sh use HOST and MODE Minor: - AGENTS.md: Add -e NO_COLOR=1 -e TERM=dumb to TOML args example - AGENTS.md: Update make test-all descriptions to mention implicit build step
Copilot
AI
changed the title
[WIP] Fix documentation for auth token environment variables
docs: reconcile documentation with implementation (9 discrepancies)
May 29, 2026
Contributor
There was a problem hiding this comment.
Pull request overview
Documentation-only reconciliation that closes 9 gaps identified by the nightly docs reconciler, aligning README.md, AGENTS.md, and docs/ENVIRONMENT_VARIABLES.md with the current implementation of token lookup, tracing, gateway configuration, container runtime variables, and the test/build targets.
Changes:
- README gains Authentication, Tracing, and Gateway Configuration sections (token priority, OTEL vars, key gateway fields including
trusted_bots). - AGENTS.md clarifies
make test-allbuild behavior and addsNO_COLOR=1/TERM=dumbto the GitHub stdio Docker example, plus a pointer todocs/CONFIGURATION.mdfor the full field list. docs/ENVIRONMENT_VARIABLES.mdaddsTAVILY_API_KEYand re-attributesMCP_GATEWAY_HOST/MCP_GATEWAY_MODEto bothrun.shandrun_containerized.sh.
Show a summary per file
| File | Description |
|---|---|
| README.md | Adds Authentication, Tracing, and Gateway Configuration sections; broadens env-vars pointer line. |
| AGENTS.md | Notes test-all build behavior, expands GitHub stdio args with NO_COLOR/TERM, adds a CONFIGURATION.md pointer. |
| docs/ENVIRONMENT_VARIABLES.md | Adds TAVILY_API_KEY row; clarifies that MCP_GATEWAY_HOST/MCP_GATEWAY_MODE are read by both run.sh and run_containerized.sh. |
Copilot's findings
Tip
Add Copilot custom instructions for smarter, more guided reviews. Learn how to get started.
- Files reviewed: 3/3 changed files
- Comments generated: 2
Co-authored-by: Copilot Autofix powered by AI <175728472+Copilot@users.noreply.github.com>
Co-authored-by: Copilot Autofix powered by AI <175728472+Copilot@users.noreply.github.com>
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
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.
Nightly reconciliation identified 9 documentation gaps where implementation behavior wasn't reflected in
README.md,AGENTS.md, ordocs/ENVIRONMENT_VARIABLES.md.README.md
GITHUB_MCP_SERVER_TOKEN→GITHUB_TOKEN→GITHUB_PERSONAL_ACCESS_TOKEN→GH_TOKEN), matchinginternal/envutil/github.go:29–32OTEL_EXPORTER_OTLP_ENDPOINT,OTEL_EXPORTER_OTLP_HEADERS,OTEL_SERVICE_NAMEvars, matchinginternal/cmd/tracing.goandinternal/tracing/config_resolver.gotrusted_bots/trustedBots; links todocs/CONFIGURATION.mdforrate_limit_threshold,rate_limit_cooldown, and the full field listAGENTS.md
docs/CONFIGURATION.mdfortrusted_bots,rate_limit_threshold,rate_limit_cooldown-e NO_COLOR=1 -e TERM=dumbto matchconfig.example.tomlbest practice; prevents ANSI codes from breaking JSON parsingmake test-all— Both Quick Start and All Tests descriptions updated to mention the implicit binary build stepdocs/ENVIRONMENT_VARIABLES.md
TAVILY_API_KEY— Added to Test/Development Overrides; enables real Tavily API tests intest/integration/(skipped when absent)run.shandrun_containerized.shreadMCP_GATEWAY_HOSTandMCP_GATEWAY_MODE(previously attributed only torun_containerized.sh)