Skip to content

docs: add coding-agent to Azure best practices options - #3387

Open
Donna Gan (bleakbelladonnals) wants to merge 1 commit into
microsoft:mainfrom
bleakbelladonnals:codex/docs-coding-agent-options-3044
Open

docs: add coding-agent to Azure best practices options#3387
Donna Gan (bleakbelladonnals) wants to merge 1 commit into
microsoft:mainfrom
bleakbelladonnals:codex/docs-coding-agent-options-3044

Conversation

@bleakbelladonnals

Copy link
Copy Markdown

What does this PR do?

Updates the Azure MCP Best Practices command reference to:

  • list coding-agent as a supported resource
  • clarify that coding-agent, like static-web-app, supports only the all action

The issue also identified missing end-to-end prompt coverage. That gap has already been resolved by later work: e2eTestPrompts.md currently includes the prompt “configure azure mcp in coding agent for my repo”. This PR therefore changes only the command reference and avoids adding duplicate prompt coverage.

This is a documentation-only change; it does not change command behavior or tool metadata.

GitHub issue number?

Fixes #3044

Validation

  • confirmed BestPracticesOptions.cs lists coding-agent and restricts it to the all action
  • confirmed the existing coding-agent end-to-end prompt remains present
  • git diff --check
  • npx --yes cspell@^10.0.0 lint --config .vscode/cspell.json servers/Azure.Mcp.Server/docs/azmcp-commands.md

The PowerShell metadata script was not run because no generated tool metadata or tool implementation changed.

Pre-merge checklist

  • Read the contribution guidelines
  • PR title clearly describes the change
  • Commit history is clean with a single descriptive commit
  • Reviewed the source option descriptions and existing E2E prompt for accuracy
  • Spelling check passes
  • Tests are not applicable to this documentation-only change
  • A changelog entry is not required for this documentation-only correction

@azure-pipelines

Copy link
Copy Markdown
Azure Pipelines:
Successfully started running 1 pipeline(s).
There may be pipelines that require an authorized user to comment /azp run to run.

@github-actions

Copy link
Copy Markdown
Contributor

Thank you for your contribution Donna Gan (@bleakbelladonnals)! We will review the pull request and get back to you soon.

Copilot AI left a comment

Copy link
Copy Markdown
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Pull request overview

Updates the Azure MCP Server command reference for the Azure Best Practices tool so the documented --resource/--action options match the current implementation and intended usage.

Changes:

  • Adds coding-agent to the documented --resource options for azmcp get azure bestpractices get.
  • Updates the all action note to include coding-agent as restricted to all.

💡 Add a code-review agent skill or configure MCP servers for context-aware, tailored reviews. Learn more in the docs.

#
# Action options:
# all - Best practices for both code generation and deployment (only for static-web-app)
# all - Best practices for both code generation and deployment (only for static-web-app and coding-agent)
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Projects

None yet

Development

Successfully merging this pull request may close these issues.

[Doc Gap] Best Practices coding-agent resource option missing from azmcp-commands.md

2 participants