📚 Documentation Reconciliation Report - 2026-11-13

オープン 初心者向け
  • 何か問題がありますか？
#16,482 コメント 0 件 リアクション 0 件 担当者 0 名 GitHub で見る

メンテナーはふだん 1 日以内に返信

まだ誰も着手していません。

評価

難易度
2/5
見積もり時間
1〜3時間
初心者へのやさしさ
76/100
issue の種類
ドキュメント
明瞭さ
明確に書かれている
活発さ
活発
技術スタック
go
領域
cli, documentation

調査の方向性

internal/cmd/proxy.go の（158〜185行目付近の）フラグ登録から始めてください。各フラグのデフォルト値とヘルプテキストを控えます。OTLP フラグについては registerTracingFlags の呼び出しも含めます。次に docs/PROXY_MODE.md の Flags 表（172〜188行目付近）を開き、それらの登録と比較します。表に --force-public-repos、--wasm-cache-dir、3つの --otlp-* フラグの行があり、デフォルト値がコードと一致していれば完了です。

索引モデルが issue の本文から書いたものです。

説明

automated documentation maintenance

Summary

Found 1 minor discrepancy between documentation and implementation during the nightly reconciliation check.

Critical Issues 🔴

None found.

Important Issues 🟡

None found.

Minor Issues 🔵

1. awmg proxy flag table in docs/PROXY_MODE.md is missing several flags

Location: docs/PROXY_MODE.md, "Flags" table (around lines 172-188)
Problem: The table does not list these flags, which are registered in internal/cmd/proxy.go:

  • --force-public-repos (line 173; default is taken from MCP_GATEWAY_FORCE_PUBLIC_REPOS, otherwise true)
  • --wasm-cache-dir (line 165; default is a sibling wazero-cache directory next to --log-dir)
  • --otlp-endpoint, --otlp-service-name and --otlp-sample-rate, registered through registerTracingFlags

Actual Behavior: All of these flags are accepted by awmg proxy. --force-public-repos is not mentioned in any Markdown file. --wasm-cache-dir appears only in the gateway flag list in README.md (line 67) and in the MCP_GATEWAY_WASM_CACHE_DIR entry of docs/ENVIRONMENT_VARIABLES.md.
Impact: Proxy users cannot discover these flags from the proxy documentation. This is especially relevant for --force-public-repos, which changes the effective guard policy.
Suggested Fix: Add rows for the flags above to the docs/PROXY_MODE.md Flags table, with defaults and descriptions taken from the flag help text in internal/cmd/proxy.go.
Code Reference: internal/cmd/proxy.go:158-185

Documentation Completeness

Missing Documentation
  • The proxy flags listed above.
Outdated Documentation
  • None found.
Accurate Sections ✅
  • Go version: go.mod, Makefile (GO_VERSION), CONTRIBUTING.md, README.md and AGENTS.md all say 1.26.10.
  • Quick Start JSON stdin example: the gateway section is required with port and domain, matching internal/config/schema/mcp-gateway-config.schema.json (required port and domain, with agentId or agentIds).
  • Server fields (type, container, entrypoint, entrypointArgs, args, mounts, env, connectTimeout, toolTimeout) all exist in StdinServerConfig. No command field is documented for JSON stdin.
  • Gateway fields in the README.md table match StdinGatewayConfig in internal/config/config_stdin.go.
  • Every non-test os.Getenv / os.LookupEnv variable in internal/ and main.go is documented. The only undocumented names in the scan were test fixtures and GITHUB_ACTIONS, which I did not investigate further.
  • Every awmg flag registered in internal/cmd is documented somewhere in the docs, apart from the proxy flags above. The scan also flagged --verbose, a Cobra counter flag shown as -v/-vv in CONTRIBUTING.md.
  • All relative links in README.md and CONTRIBUTING.md that point into docs/, internal/, scripts/ and test/ resolve to existing files.

Tested Commands

  • ✅ Every make target named in CONTRIBUTING.md and AGENTS.md exists in the Makefile: build, test, test-unit, test-integration, test-all, test-ci, lint, coverage, install, format, clean, agent-finished.
  • ⚠️ make build could not be verified. The sandbox firewall blocked proxy.golang.org (TLS certificate error), so module downloads failed and the awmg binary was not produced. As a result ./awmg --help was not run; I checked flags statically from internal/cmd/*.go instead.
  • ⚠️ The external spec link (https://github.com/github/gh-aw/blob/main/docs/src/content/docs/reference/mcp-gateway.md) and the token page link were not checked, because network access is restricted.

Recommendations

Immediate Actions Required:

None.

Nice to Have:
  1. Add the missing proxy flags to docs/PROXY_MODE.md.

Code References

  • Proxy flags: internal/cmd/proxy.go
  • Configuration structs: internal/config/config_core.go, internal/config/config_stdin.go
  • Validation logic: internal/config/validation_schema.go (and internal/config/schema/mcp-gateway-config.schema.json)

Generated by Nightly Documentation Reconciler · copilot · routed: sonnet55 high · ~35 AIC · ⊞ 2.1K · ◷

  • expires on Nov 16, 2026, 10:45 PM UTC
主要言語
Go
スター
188
フォーク
60
平均マージ
6時間 45分
マージ済み PR（30日）
198

環境構築

Codespaces で開く

このプロジェクトの開発コンテナを、あなたの GitHub アカウントでブラウザ上に起動します。

はじめの一歩

  1. issue を最後まで読み、次にプロジェクトのコントリビューションガイドを読みます。
  2. 着手することを issue にコメントします — 二人が同じ作業をするのを防げます。
  3. リポジトリをフォークし、ブランチを切って変更します。
  4. issue 番号を参照したプルリクエストを送ります。

github/gh-aw-mcpg のほかの issue

github/gh-aw-mcpg の issue をすべて見る

似ている issue

Go の issue をもっと見る

新しい issue をメールで受け取る

初心者向けの GitHub issue を短くまとめたダイジェスト。