docs: document OIDC auth for HTTP servers and advanced CLI flags#3017
Merged
docs: document OIDC auth for HTTP servers and advanced CLI flags#3017
Conversation
- Add auth field documentation (github-oidc) to docs/CONFIGURATION.md - Add OIDC environment variables section to docs/ENVIRONMENT_VARIABLES.md - Add Advanced Flags subsection to CONTRIBUTING.md Closes #2981 Co-authored-by: Copilot <223556219+Copilot@users.noreply.github.com>
Contributor
There was a problem hiding this comment.
Pull request overview
This PR closes the documentation gaps identified in #2981 by documenting the existing GitHub Actions OIDC auth support for HTTP MCP backends and by adding examples of advanced awmg CLI flags for local development workflows.
Changes:
- Documented
auth.type: "github-oidc"(and optionalaudience) for HTTP servers indocs/CONFIGURATION.md, including behavior notes and an example. - Added a new section describing
ACTIONS_ID_TOKEN_REQUEST_URLandACTIONS_ID_TOKEN_REQUEST_TOKENindocs/ENVIRONMENT_VARIABLES.md. - Added an “Advanced Flags” subsection to
CONTRIBUTING.mdwith practical examples for--log-dir,--env,-v,--payload-dir, and--payload-size-threshold.
Reviewed changes
Copilot reviewed 3 out of 3 changed files in this pull request and generated no comments.
| File | Description |
|---|---|
| docs/ENVIRONMENT_VARIABLES.md | Adds GitHub Actions OIDC environment variables required by github-oidc HTTP server auth. |
| docs/CONFIGURATION.md | Documents the auth server field for HTTP backends, including github-oidc semantics and example config. |
| CONTRIBUTING.md | Adds examples for advanced runtime flags commonly used when running locally. |
💡 Add Copilot custom instructions for smarter, more guided reviews. Learn how to get started.
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.
Summary
Addresses documentation gaps found by the Nightly Documentation Reconciler (#2981).
Changes
1. OIDC Authentication for HTTP Servers (
docs/CONFIGURATION.md)Documents the
authfield for HTTP MCP backend servers:type: "github-oidc"— obtains GitHub Actions OIDC tokens and attaches them as Bearer headersaudience— optional OIDC audience (defaults to server URL)2. OIDC Environment Variables (
docs/ENVIRONMENT_VARIABLES.md)Adds new "GitHub Actions OIDC Variables" section documenting:
ACTIONS_ID_TOKEN_REQUEST_URL— OIDC token endpoint (set by Actions runner)ACTIONS_ID_TOKEN_REQUEST_TOKEN— bearer token for OIDC requests (set by Actions runner)3. Advanced CLI Flags (
CONTRIBUTING.md)Adds an "Advanced Flags" subsection to "Running Locally" with examples for:
--log-dir,--env,-v,--payload-dir,--payload-size-thresholddocs/ENVIRONMENT_VARIABLES.mdfor full listCloses #2981