{Codespaces} Refactor MCP server (#32233)

Co-authored-by: Copilot <[email protected]>

Author: necusjz

.devcontainer/mcp.json

@@ -3,14 +3,8 @@
     "AAZ Flow": {
       "command": "python",
       "args": [
-        "azure-cli/tools/aaz-flow/main.py"
+        "azure-cli/tools/aaz-flow/src/aaz-flow/main.py"
       ],
-      "env": {
-          "AAZ_PATH": "/workspaces/aaz",
-          "CLI_PATH": "/workspaces/azure-cli",
-          "CLI_EXTENSION_PATH": "/workspaces/azure-cli-extensions",
-          "SWAGGER_PATH": "/workspaces/azure-rest-api-specs"
-      }
     }
   }
 }

doc/hands_on_codespace.md

@@ -3,17 +3,17 @@ GitHub Codespace is a great option for developers who prefer to work in containe
 ## Create a codespace
 1. In your browser, navigate to the [Official Repository of Azure CLI](https://github.com/Azure/azure-cli).
 2. Above the file list, click **Code** > **Codespaces** > **Create codespace on dev**.
-![](./assets/codespace_entry.png)
+![](https://raw.githubusercontent.com/Azure/azure-cli/refs/heads/dev/doc/assets/codespace_entry.png)
 
 With Codespace, all pre-requisites are installed for you, including the [AAZ Flow MCP server](https://github.com/Azure/azure-cli/tree/dev/tools/aaz-flow).
-![](./assets/codespace_mcp.png)
+![](https://raw.githubusercontent.com/Azure/azure-cli/refs/heads/dev/doc/assets/codespace_mcp.png)
 
 ## Authenticate with GitHub
 Once codespace is created (takes a while), you will see the following prompt in the integrated terminal:
-![](./assets/codespace_login.png)
+![](https://raw.githubusercontent.com/Azure/azure-cli/refs/heads/dev/doc/assets/codespace_login.png)
 
 It helps login to your GitHub account interactively; after logging in, you won't need to do it again in a fresh terminal:
-![](./assets/codespace_logged.png)
+![](https://raw.githubusercontent.com/Azure/azure-cli/refs/heads/dev/doc/assets/codespace_logged.png)
 
 Furthermore, all dependencies will be installed automatically, and once a similar prompt appears, you can start development:
 ```commandline
@@ -36,16 +36,16 @@ It will convert the specification from https://github.com/Azure/azure-rest-api-s
 
 ### Prune command-line interface
 Typically, the interface generated directly from the specification isn’t ideal. You can refine it in the [Workspace Editor](https://azure.github.io/aaz-dev-tools/pages/usage/workspace-editor/) to make it meet our requirements. You can open or create a workspace at:
-![](./assets/codespace_workspace_editor_1.png)
+![](https://raw.githubusercontent.com/Azure/azure-cli/refs/heads/dev/doc/assets/codespace_workspace_editor_1.png)
 
 If everything is selected correctly, you will be redirected to the following UI. You can interactively edit our ideal command line interface based on that:
-![](./assets/codespace_workspace_editor_2.png)
+![](https://raw.githubusercontent.com/Azure/azure-cli/refs/heads/dev/doc/assets/codespace_workspace_editor_2.png)
 
 When you have completed all the editing in Workspace Editor and clicked EXPORT in its upper right corner. It's ready to switch to [CLI Generator](https://azure.github.io/aaz-dev-tools/pages/usage/cli-generator/) to generate code of Azure CLI:
 1. You need to select the target for generating code. If you don't know where to generate the code, usually Azure CLI Extension is all you need:
-    ![](./assets/codespace_cli_generator_1.png)
+    ![](https://raw.githubusercontent.com/Azure/azure-cli/refs/heads/dev/doc/assets/codespace_cli_generator_1.png)
 2. You can find the commands that you modified before in the following UI. Check the corresponding checkboxes, then click GENERATE in the upper right corner, and the code will be generated:
-    ![](./assets/codespace_cli_generator_2.png)
+    ![](https://raw.githubusercontent.com/Azure/azure-cli/refs/heads/dev/doc/assets/codespace_cli_generator_2.png)
 
 ### Implement custom logic (optional)
 Sometimes, the generated code may not fully meet the requirements. In such cases, you'll need to make some customizations based on it. This process can be relatively complex, so please refer to the [relevant documentation](https://azure.github.io/aaz-dev-tools/pages/usage/customization/).
@@ -65,11 +65,11 @@ Please note that AAZ Flow is currently in early development. The functionality a
 
 ### Tools
 You can easily start the MCP server within your codespace environment:
-![](./assets/codespace_mcp_start.png)
+![](https://raw.githubusercontent.com/Azure/azure-cli/refs/heads/dev/doc/assets/codespace_mcp_start.png)
 
 Please setup your Copilot to use the AI features (**Ctrl** + **Alt** + **I** to open a chat):
-![](./assets/codespace_copilot.png)
+![](https://raw.githubusercontent.com/Azure/azure-cli/refs/heads/dev/doc/assets/codespace_copilot.png)
 
-After that, set the mode to `Agent` and the model to `Claude Sonnet`. The following is the usage scenario of the tools:
-1. "generate test for chaos module" to generate test cases in `chaos` module.
-2. "generate code for azure cli" to generate models and codes.
+After that, set the mode to `Agent` and the model to `Claude Sonnet`. The following is the use case of the tools:
+1. "generate test for chaos module" to generate test cases in _chaos_ module.
+2. "generate code for azure cli" to generate models AND codes.

tools/aaz-flow/.gitignore

@@ -0,0 +1,207 @@
+# Byte-compiled / optimized / DLL files
+__pycache__/
+*.py[codz]
+*$py.class
+
+# C extensions
+*.so
+
+# Distribution / packaging
+.Python
+build/
+develop-eggs/
+dist/
+downloads/
+eggs/
+.eggs/
+lib/
+lib64/
+parts/
+sdist/
+var/
+wheels/
+share/python-wheels/
+*.egg-info/
+.installed.cfg
+*.egg
+MANIFEST
+
+# PyInstaller
+#  Usually these files are written by a python script from a template
+#  before PyInstaller builds the exe, so as to inject date/other infos into it.
+*.manifest
+*.spec
+
+# Installer logs
+pip-log.txt
+pip-delete-this-directory.txt
+
+# Unit test / coverage reports
+htmlcov/
+.tox/
+.nox/
+.coverage
+.coverage.*
+.cache
+nosetests.xml
+coverage.xml
+*.cover
+*.py.cover
+.hypothesis/
+.pytest_cache/
+cover/
+
+# Translations
+*.mo
+*.pot
+
+# Django stuff:
+*.log
+local_settings.py
+db.sqlite3
+db.sqlite3-journal
+
+# Flask stuff:
+instance/
+.webassets-cache
+
+# Scrapy stuff:
+.scrapy
+
+# Sphinx documentation
+docs/_build/
+
+# PyBuilder
+.pybuilder/
+target/
+
+# Jupyter Notebook
+.ipynb_checkpoints
+
+# IPython
+profile_default/
+ipython_config.py
+
+# pyenv
+#   For a library or package, you might want to ignore these files since the code is
+#   intended to run in multiple environments; otherwise, check them in:
+# .python-version
+
+# pipenv
+#   According to pypa/pipenv#598, it is recommended to include Pipfile.lock in version control.
+#   However, in case of collaboration, if having platform-specific dependencies or dependencies
+#   having no cross-platform support, pipenv may install dependencies that don't work, or not
+#   install all needed dependencies.
+#Pipfile.lock
+
+# UV
+#   Similar to Pipfile.lock, it is generally recommended to include uv.lock in version control.
+#   This is especially recommended for binary packages to ensure reproducibility, and is more
+#   commonly ignored for libraries.
+#uv.lock
+
+# poetry
+#   Similar to Pipfile.lock, it is generally recommended to include poetry.lock in version control.
+#   This is especially recommended for binary packages to ensure reproducibility, and is more
+#   commonly ignored for libraries.
+#   https://python-poetry.org/docs/basic-usage/#commit-your-poetrylock-file-to-version-control
+#poetry.lock
+#poetry.toml
+
+# pdm
+#   Similar to Pipfile.lock, it is generally recommended to include pdm.lock in version control.
+#   pdm recommends including project-wide configuration in pdm.toml, but excluding .pdm-python.
+#   https://pdm-project.org/en/latest/usage/project/#working-with-version-control
+#pdm.lock
+#pdm.toml
+.pdm-python
+.pdm-build/
+
+# pixi
+#   Similar to Pipfile.lock, it is generally recommended to include pixi.lock in version control.
+#pixi.lock
+#   Pixi creates a virtual environment in the .pixi directory, just like venv module creates one
+#   in the .venv directory. It is recommended not to include this directory in version control.
+.pixi
+
+# PEP 582; used by e.g. github.com/David-OConnor/pyflow and github.com/pdm-project/pdm
+__pypackages__/
+
+# Celery stuff
+celerybeat-schedule
+celerybeat.pid
+
+# SageMath parsed files
+*.sage.py
+
+# Environments
+.env
+.envrc
+.venv
+env/
+venv/
+ENV/
+env.bak/
+venv.bak/
+
+# Spyder project settings
+.spyderproject
+.spyproject
+
+# Rope project settings
+.ropeproject
+
+# mkdocs documentation
+/site
+
+# mypy
+.mypy_cache/
+.dmypy.json
+dmypy.json
+
+# Pyre type checker
+.pyre/
+
+# pytype static type analyzer
+.pytype/
+
+# Cython debug symbols
+cython_debug/
+
+# PyCharm
+#  JetBrains specific template is maintained in a separate JetBrains.gitignore that can
+#  be found at https://github.com/github/gitignore/blob/main/Global/JetBrains.gitignore
+#  and can be added to the global gitignore or merged into this file.  For a more nuclear
+#  option (not recommended) you can uncomment the following to ignore the entire idea folder.
+#.idea/
+
+# Abstra
+# Abstra is an AI-powered process automation framework.
+# Ignore directories containing user credentials, local state, and settings.
+# Learn more at https://abstra.io/docs
+.abstra/
+
+# Visual Studio Code
+#  Visual Studio Code specific template is maintained in a separate VisualStudioCode.gitignore 
+#  that can be found at https://github.com/github/gitignore/blob/main/Global/VisualStudioCode.gitignore
+#  and can be added to the global gitignore or merged into this file. However, if you prefer, 
+#  you could uncomment the following to ignore the entire vscode folder
+# .vscode/
+
+# Ruff stuff:
+.ruff_cache/
+
+# PyPI configuration file
+.pypirc
+
+# Cursor
+#  Cursor is an AI-powered code editor. `.cursorignore` specifies files/directories to
+#  exclude from AI features like autocomplete and code analysis. Recommended for sensitive data
+#  refer to https://docs.cursor.com/context/ignore-files
+.cursorignore
+.cursorindexingignore
+
+# Marimo
+marimo/_static/
+marimo/_lsp/
+__marimo__/

tools/aaz-flow/CHANGELOG.md

@@ -0,0 +1,17 @@
+# Changelog
+
+All notable changes to this project will be documented in this file.
+
+The format is based on [Keep a Changelog](https://keepachangelog.com/en/1.0.0/),
+and this project adheres to [Semantic Versioning](https://semver.org/spec/v2.0.0.html).
+
+## [Unreleased]
+
+[1.0.0] - 2025-10-13
+- Applied `hatchling` as build backend.
+- Refined the project structure.
+
+[0.1.0] - 2025-10-08
+- Added tool for code generation.
+- Added tool for test generation.
+- Initialized MCP server.

tools/aaz-flow/LICENSE

@@ -0,0 +1,21 @@
+MIT License
+
+Copyright (c) 2025 Microsoft Corporation
+
+Permission is hereby granted, free of charge, to any person obtaining a copy
+of this software and associated documentation files (the "Software"), to deal
+in the Software without restriction, including without limitation the rights
+to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
+copies of the Software, and to permit persons to whom the Software is
+furnished to do so, subject to the following conditions:
+
+The above copyright notice and this permission notice shall be included in all
+copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
+IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
+FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
+AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
+LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
+OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
+SOFTWARE.

tools/aaz-flow/README.md

@@ -1,14 +1,15 @@
-## AAZ MCP Server
-MCP Server for the AAZ API, enabling prune command-line interface, implement custom logic, generate meaningful example, and more.
+## AAZ Flow
+AAZ Flow is the MCP server for the AAZ APIs, enabling pruning of command-line interfaces, implementing custom logic, generating test cases, and more.
 
 Please note that AAZ Flow is currently in early development. The functionality and available tools are subject to change and expansion as we continue to develop and improve the server.
 
 ### Tools
-`generate_code`
-
-## Implementation
-1. Performs elicitation for user input to perform workflow
-2. Generates content using llm sampling
-3. Executes AAZ Flow commands directly
-4. Generates tests using llm sampling
-5. Uses tool transformation to make the internal tooling more friendly for llms
+You can easily start the MCP server within your codespace environment:
+![](https://raw.githubusercontent.com/Azure/azure-cli/refs/heads/dev/doc/assets/codespace_mcp_start.png)
+
+Please setup your Copilot to use the AI features (**Ctrl** + **Alt** + **I** to open a chat):
+![](https://raw.githubusercontent.com/Azure/azure-cli/refs/heads/dev/doc/assets/codespace_copilot.png)
+
+After that, set the mode to `Agent` and the model to `Claude Sonnet`. The following is the use case of the tools:
+1. "generate test for chaos module" to generate test cases in _chaos_ module.
+2. "generate code for azure cli" to generate models AND codes.

tools/aaz-flow/pyproject.toml

@@ -1,12 +1,19 @@
+[build-system]
+requires = ["hatchling"]
+build-backend = "hatchling.build"
+
 [project]
 name = "aaz-flow"
-version = "0.1.0"
-description = "The MCP server utilized for code generation in Azure CLI (AAZ)."
+version = "1.0.0"
+description = "AAZ Flow is the MCP server for the AAZ APIs."
 readme = "README.md"
 requires-python = ">=3.12"
 dependencies = [
-    "fastmcp>=2.11.3"
+  "fastmcp>=2.11.0,<3.0.0"
 ]
 
-[tool.setuptools]
-py-modules = ["helpers", "main", "models"]
+[tool.hatch.build]
+packages = ["src/aaz-flow"]
+
+[tool.hatch.version]
+path = "src/aaz-flow/__init__.py"

tools/aaz-flow/__init__.py tools/aaz-flow/src/aaz-flow/__init__.pytools/aaz-flow/__init__.py renamed to tools/aaz-flow/src/aaz-flow/__init__.py

@@ -2,5 +2,4 @@
 # Copyright (c) Microsoft Corporation. All rights reserved.
 # Licensed under the MIT License. See License.txt in the project root for license information.
 # --------------------------------------------------------------------------------------------
-
-# AAZ Flow package
+__version__ = "1.0.0"  # https://semver.org/#summary