📚 Documentation Reconciliation Report - 2026-11-17

オープン 初心者向け
#16,717 コメント 0 件 リアクション 0 件 担当者 0 名 GitHub で見る

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

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

評価

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

調査の方向性

docs/ENVIRONMENT_VARIABLES.md の「Container Runtime Configuration」セクションを読み、その形式を README.md と docs/CONFIGURATION.md の既存の記述と比較してください。また、CONTRIBUTING.md の「Linting」セクションを .golangci.yml および AGENTS.md と照らし合わせて確認してください。文書に記載された両方の不一致を修正した時点で完了です。

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

説明

automated documentation maintenance

Summary

Found 2 minor discrepancies between documentation and implementation during nightly reconciliation. No critical or important issues were found.

Critical Issues 🔴

None.

Important Issues 🟡

None.

Minor Issues 🔵

1. MCP_GATEWAY_ALLOWED_MOUNT_ROOTS missing from the "complete" env var reference

Location: docs/ENVIRONMENT_VARIABLES.md
Problem: The file describes itself as a "Complete reference for MCP Gateway environment variables", but it never mentions MCP_GATEWAY_ALLOWED_MOUNT_ROOTS. The variable is documented in README.md, AGENTS.md and docs/CONFIGURATION.md:192.
Actual Behavior: The launcher reads it and enforces it immediately before container launch (internal/launcher/mount_policy.go:20, AllowedMountRootsEnvVar).
Impact: Users who consult the dedicated env var reference will not learn about the mount allowlist. The default roots are $GITHUB_WORKSPACE and the working directory read-only, plus the system temp dir read-write.
Suggested Fix: Add a row to docs/ENVIRONMENT_VARIABLES.md, for example under "Container Runtime Configuration": MCP_GATEWAY_ALLOWED_MOUNT_ROOTS — comma-separated path[:ro|:rw] allowlist of host roots for bind mounts (default ro).

2. CONTRIBUTING.md lint section omits the testifylint linter

Location: CONTRIBUTING.md, "Linting" section (~line 175-190)
Problem: It says golangci-lint runs "additional static analysis (misspell, unconvert)".
Actual Behavior: .golangci.yml enables misspell, testifylint (with enable-all: true) and unconvert. AGENTS.md documents testifylint.
Impact: Contributors may not realize the testify assertion style rules are enforced in CI.
Suggested Fix: Change the text to "(misspell, testifylint, unconvert)".

Documentation Completeness

Missing Documentation
  • MCP_GATEWAY_ALLOWED_MOUNT_ROOTS in docs/ENVIRONMENT_VARIABLES.md (see above).
Outdated Documentation
  • None found.
Accurate Sections ✅
  • README Docker quick start: the JSON config matches internal/config/config_stdin.go and the schema. gateway requires port and domain plus exactly one of agentId/agentIds. The docker run flags match run_containerized.sh, which passes --config-stdin.
  • README JSON stdin examples: no command field is used, and all fields (container, entrypoint, entrypointArgs, mounts, args, env, type, connectTimeout, toolTimeout) exist in the stdin structs.
  • README gateway field table: matches the config_core.go toml tags and config_stdin.go json tags. dockerless is correctly noted as JSON stdin only (toml:"-").
  • README CLI flag list: every flag listed exists in internal/cmd/, including --shutdown-timeout, --otlp-*, --tls-*, --hmac-secret and --wasm-cache-dir. The proxy flags --guard-wasm, --policy, --github-token and --listen also exist.
  • README environment variables: every MCP_GATEWAY_*, GITHUB_* and OTEL_* variable read in non-test Go code is documented in README, AGENTS.md or docs/ENVIRONMENT_VARIABLES.md, except the gap above. Defaults match the code: 6h session timeout, 5s shutdown timeout, 524288 payload threshold, 30s startup timeout, 60s tool timeout, 1500s keepalive.
  • External spec link github/gh-aw docs/src/content/docs/reference/mcp-gateway.md resolves.
  • CONTRIBUTING.md: Go 1.26.10 matches go.mod and .golangci.yml. All documented make targets exist: build, test, test-unit, test-integration, test-all, test-ci, test-race, test-rust, test-container-proxy, coverage, format, clean, install, agent-finished, release, compile-workflows, lint and help. The binary name awmg matches. The internal/ project structure tree matches the actual directories (31 packages).

Tested Commands

  • ✅ make --dry-run for build, test, test-unit, test-integration, test-all, lint, coverage, install, format, clean, agent-finished, test-ci, test-race and test-rust: all targets exist and match their descriptions.
  • ⚠️ make build: could not complete in this sandbox because go mod tidy needs proxy.golang.org, which fails TLS verification. This is an environment limitation, not a docs problem. CONTRIBUTING.md already notes the network requirement. ./awmg --help was verified by reading the flag registrations in internal/cmd/ instead.

Recommendations

Immediate Actions Required:

None.

Nice to Have:
  1. Add MCP_GATEWAY_ALLOWED_MOUNT_ROOTS to docs/ENVIRONMENT_VARIABLES.md.
  2. Add testifylint to the CONTRIBUTING.md linter list.

Code References

  • Configuration structs: internal/config/config_core.go, internal/config/config_stdin.go
  • Schema: internal/config/schema/mcp-gateway-config.schema.json
  • Mount allowlist env var: internal/launcher/mount_policy.go:20
  • Lint config: .golangci.yml

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

  • expires on Nov 20, 2026, 10:46 PM UTC
主要言語
Go
スター
188
フォーク
60
平均マージ
6時間 50分
マージ済み PR(30日)
177

環境構築

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 を短くまとめたダイジェスト。