Skip to content

[Doc Gap] azmcp deploy plan get — --workspace-folder removed from code but still documented in azmcp-commands.md #3147

Description

@github-actions

Documentation Gap

Server: Azure.Mcp.Server
Tool directory: tools/Azure.Mcp.Tools.Deploy
Triggered by: commit 50309cc24695a3d641f48d53e9d44bb14d55c623 (PR #3143) by @alzimmermsft
Changed files:

  • tools/Azure.Mcp.Tools.Deploy/src/Options/Plan/GetOptions.cs
  • tools/Azure.Mcp.Tools.Deploy/tests/Azure.Mcp.Tools.Deploy.Tests/Commands/Plan/GetCommandTests.cs

What Changed

PR #3143 ("POCO-based options follow-ups") removed the WorkspaceFolder / --workspace-folder parameter from tools/Azure.Mcp.Tools.Deploy/src/Options/Plan/GetOptions.cs. The property and all test references to --workspace-folder were deleted, making --project-name the first (and only required) parameter.

Gaps Found

  • azmcp deploy plan get: --workspace-folder <workspace-folder> is still shown as the first required parameter in azmcp-commands.md (line ~2386), but the parameter no longer exists in the code.

Files to Update

  • servers/Azure.Mcp.Server/docs/azmcp-commands.md

Context

Current docs (lines ~2383–2393 of azmcp-commands.md):

# Get a deployment plan for a specific project
azmcp deploy plan get --workspace-folder <workspace-folder> \
                      --project-name <project-name> \
                      --target-app-service <target-app-service> \
                      --provisioning-tool <provisioning-tool> \
                      --source-type <source-type> \
                      [--iac-options <iac-options>] \
                      [--deploy-option <deploy-option>] \
                      [--resource-group <resource-group>] \
                      [--subscription <subscription>]

After the PR, GetOptions.cs only has: ProjectName (required), TargetAppService, ProvisioningTool, SourceType, DeployOption, IacOptions, ResourceGroup, Subscription. No WorkspaceFolder.

📐 Implementation Guide

This section contains step-by-step instructions for a coding agent to implement the changes described above.

Step 1: Modify files

File: servers/Azure.Mcp.Server/docs/azmcp-commands.md
Action: Edit the ### Azure Deploy Operations section — remove --workspace-folder from the deploy plan get command signature.

Replace:

# Get a deployment plan for a specific project
# ❌ Destructive | ✅ Idempotent | ❌ OpenWorld | ✅ ReadOnly | ❌ Secret | ❌ LocalRequired
azmcp deploy plan get --workspace-folder <workspace-folder> \
                      --project-name <project-name> \
                      --target-app-service <target-app-service> \
                      --provisioning-tool <provisioning-tool> \
                      --source-type <source-type> \
                      [--iac-options <iac-options>] \
                      [--deploy-option <deploy-option>] \
                      [--resource-group <resource-group>] \
                      [--subscription <subscription>]

With:

# Get a deployment plan for a specific project
# ❌ Destructive | ✅ Idempotent | ❌ OpenWorld | ✅ ReadOnly | ❌ Secret | ❌ LocalRequired
azmcp deploy plan get --project-name <project-name> \
                      [--target-app-service <target-app-service>] \
                      [--provisioning-tool <provisioning-tool>] \
                      [--source-type <source-type>] \
                      [--iac-options <iac-options>] \
                      [--deploy-option <deploy-option>] \
                      [--resource-group <resource-group>] \
                      [--subscription <subscription>]

Note: --target-app-service, --provisioning-tool, and --source-type are string? (optional) in GetOptions.cs and should use bracket notation. This also supersedes issue #3116's fix for this command.

Step 2: Verify documentation structure

servers/Azure.Mcp.Server/docs/azmcp-commands.md — optional parameters use [--param <value>] notation, required parameters use bare --param <value>.

Step 3: Validate

  1. dotnet build servers/Azure.Mcp.Server/ — confirms the server project compiles cleanly
  2. dotnet build tools/Azure.Mcp.Tools.Deploy/src/ — confirms the affected toolset compiles
  3. dotnet test tools/Azure.Mcp.Tools.Deploy/tests/Azure.Mcp.Tools.Deploy.Tests/ --filter "TestType!=Live" — runs unit tests
  4. .\eng\common\spelling\Invoke-Cspell.ps1 — checks spelling in modified documentation

Next Steps

Tip

Ready for automated implementation? Assign this issue to @copilot to have Copilot coding agent implement the changes described in the Implementation Guide above

Generated by Documentation Updater · ● 10.4M ·

Metadata

Metadata

Assignees

No one assigned

    Labels

    copilotdocumentationImprovements or additions to documentation

    Type

    Projects

    No projects

    Milestone

    No milestone

    Relationships

    None yet

    Development

    No branches or pull requests

    Issue actions