Skip to content

docs(site): document built-in CLI tools (az and gh) in tools reference#962

Draft
github-actions[bot] wants to merge 1 commit into
mainfrom
docs/site-builtin-clis-az-gh-d10522e901a24afc
Draft

docs(site): document built-in CLI tools (az and gh) in tools reference#962
github-actions[bot] wants to merge 1 commit into
mainfrom
docs/site-builtin-clis-az-gh-d10522e901a24afc

Conversation

@github-actions

Copy link
Copy Markdown
Contributor

Summary

  • Agents and operators can now find complete documentation for the two always-on built-in CLIs (az and gh) directly in the site's Tools reference — previously this existed only in the repo-level docs/tools.md.
  • The az section explains why az is available without opt-in, the runtime detection + AW_AZ_MOUNTS graceful degradation model (with a runner posture table), the conditional agent prompt advisory, and the auth scope split between az devops * (auto-authenticated) and general ARM/Graph commands (require explicit login).
  • The network.mdx default domains table gains its missing aka.ms row, contributed by the always-on Azure CLI extension.

Changes

  • site/src/content/docs/reference/tools.mdx
    • Added ## Built-in CLIs section after the "Azure DevOps MCP" section
    • Added ### Azure CLI (az) subsection: detection mechanism, AW_AZ_MOUNTS, degradation table, :::caution[Auth scope] callout, conditional prompt advisory
    • Added ### GitHub CLI (gh) subsection
  • site/src/content/docs/reference/network.mdx
    • Added aka.ms row to the "Default Allowed Domains" table with attribution to the always-on Azure CLI extension

Accuracy checks

  • AzureCliExtension::required_hosts() in src/compile/extensions/azure_cli.rs confirmed as the source for login.microsoftonline.com, login.windows.net, management.azure.com, graph.microsoft.com, aka.ms
  • AzureCliExtension collected in collect_extensions() unconditionally — confirmed always-on
  • Detection step (detection_step()) verified at src/compile/extensions/azure_cli.rs:128–161: checks /usr/bin/az + /opt/az, sets AW_AZ_MOUNTS to mounts or empty string, emits ##vso[task.logissue type=warning] on miss
  • Prompt advisory step (prompt_append_step()) verified with condition: ne(variables['AW_AZ_MOUNTS'], '')
  • AZURE_DEVOPS_EXT_PAT passthrough via permissions.read path confirmed in azure_devops/extension.rs
  • gh assumption (no install step, uses GITHUB_TOKEN) verified in src/compile/extensions/github.rs

Validation

  • cd site && npm ci && npm run build
  • All internal links valid (confirmed by build output)

Created by the docs-writer workflow.

Generated by Docs Writer · sonnet46 3.8M ·

Add a new 'Built-in CLIs' section to site/src/content/docs/reference/tools.mdx
documenting the always-on Azure CLI (az) and GitHub CLI (gh) availability,
runtime detection mechanism, AW_AZ_MOUNTS graceful degradation, conditional
agent prompt advisory, and auth scope.

Also add the aka.ms domain row to the default allowed domains table in
network.mdx — this domain is contributed by the always-on Azure CLI extension,
not CORE_ALLOWED_HOSTS, and was missing from the site table.

Co-authored-by: Copilot <223556219+Copilot@users.noreply.github.com>
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

0 participants