Add tools for agents (#24962)

* Initial MCP server for Go SDK tool

* update mod

* update

* add mcp config

* move tools from mcp to generator tools, remove useless go version config and update the readme template

* revert mcp

* remove useless part

* fix

* changelog

* review update

---------

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

Author: tadelesh

eng/tools/generator/CHANGELOG.md

@@ -1,6 +1,18 @@
 # Release History
 
-## 0.2.0 (2025-07-23)
+## 0.2.0 (UNRELEASED)
+
+### Features Added
+
+- Add `environment` command to check and validate environment prerequisites for Azure Go SDK generation.
+- Add `generate` command to generate Azure Go SDK packages from TypeSpec specifications.
+
+### Breaking Changes
+
+- Remove `go-version` flag from all commands. It is useless since the code generator could handle it.
+
+### Bugs Fixed
+
 - Refined dependency upgrade logic to explicitly upgrade `azcore` and `azidentity` dependencies instead of using generic `go get -u ./... toolchain@none`
 
 ## 0.1.0 (2025-07-21)

eng/tools/generator/README.md

@@ -6,6 +6,8 @@ This is a command line tool for generating new releases and managing automation
 
 The generator tool provides several commands to support the Azure SDK for Go development lifecycle:
 
+- **Environment**: Check and validate development environment prerequisites
+- **Generate**: Generate individual SDK packages from TypeSpec specifications
 - **Issue Management**: Parse GitHub release request issues into configuration
 - **Release Generation**: Generate new SDK releases from TypeSpec or Swagger specifications  
 - **Automation**: Process batch SDK generation for CI/CD pipelines
@@ -16,6 +18,114 @@ The generator tool provides several commands to support the Azure SDK for Go dev
 
 This CLI tool provides the following commands:
 
+### The `environment` command
+
+The `environment` command checks and validates environment prerequisites for Azure Go SDK generation. It verifies the installation and versions of required tools and can automatically install missing TypeSpec tools.
+
+**Usage:**
+```bash
+generator environment [flags]
+```
+
+**Flags:**
+- `--auto-install`: Automatically install missing TypeSpec tools (default: true)
+- `-o, --output`: Output format, either "text" or "json" (default: "text")
+
+**What it checks:**
+- **Go**: Minimum version 1.23
+- **Node.js**: Minimum version 20.0.0
+- **TypeSpec compiler**: `@typespec/compiler` package
+- **TypeSpec client generator CLI**: `@azure-tools/typespec-client-generator-cli` package
+- **GitHub CLI**: Installation and authentication status
+
+**Examples:**
+```bash
+# Check environment with auto-install (default)
+generator environment
+
+# Check environment without auto-installing missing tools
+generator environment --auto-install=false
+
+# Get results in JSON format
+generator environment --output json
+
+# Get help
+generator environment --help
+```
+
+**Sample Output:**
+```
+All environment checks are satisfied! ✓
+
+✓ Go: Go version 1.24 is installed ✓
+✓ Node.js: Node.js version 22.17.1 is installed ✓
+✓ TypeSpec Compiler: TypeSpec compiler is installed ✓
+✓ TypeSpec Client Generator CLI: TypeSpec client generator CLI is installed ✓
+✓ GitHub CLI: GitHub CLI 2.40.1 is installed ✓
+✓ GitHub CLI Authentication: GitHub CLI is authenticated ✓
+
+✓ Automatically installed: TypeSpec compiler, TypeSpec client generator CLI
+```
+
+### The `generate` command
+
+The `generate` command generates Azure Go SDK packages from TypeSpec specifications. It can work with either a direct path to a TypeSpec configuration file or a GitHub PR link.
+
+**Usage:**
+```bash
+generator generate <sdk-repo-path> <spec-repo-path> [flags]
+```
+
+**Arguments:**
+- `sdk-repo-path`: Path to the local Azure SDK for Go repository
+- `spec-repo-path`: Path to the local Azure REST API Specs repository
+
+**Flags:**
+- `--tsp-config`: Direct path to tspconfig.yaml file (relative to spec repo root)
+- `--github-pr`: GitHub PR link to extract TypeSpec configuration from
+- `--debug`: Enable debug output
+- `-o, --output`: Output format, either "text" or "json" (default: "text")
+
+**Note:** You must provide exactly one of `--tsp-config` or `--github-pr`.
+
+**Examples:**
+```bash
+# Generate from direct TypeSpec config path
+generator generate /path/to/azure-sdk-for-go /path/to/azure-rest-api-specs \
+  --tsp-config specification/cognitiveservices/OpenAI.Inference/tspconfig.yaml
+
+# Generate from GitHub PR
+generator generate /path/to/azure-sdk-for-go /path/to/azure-rest-api-specs \
+  --github-pr https://github.com/Azure/azure-rest-api-specs/pull/12345
+
+# Generate with debug output and JSON format
+generator generate /path/to/azure-sdk-for-go /path/to/azure-rest-api-specs \
+  --tsp-config specification/service/namespace/tspconfig.yaml \
+  --debug --output json
+```
+
+**What it does:**
+1. Validates the provided repository paths
+2. Resolves the TypeSpec configuration (checking out PR branch if needed using GitHub CLI)
+3. Generates the Go SDK using the TypeSpec-Go emitter
+4. Reports generation results including package info, version, and breaking changes
+
+**Sample Output:**
+```
+✓ SDK generation completed successfully!
+
+Package Name: armcognitiveservices
+Package Path: /path/to/azure-sdk-for-go/sdk/resourcemanager/cognitiveservices/armcognitiveservices
+Spec Folder: /path/to/azure-rest-api-specs/specification/cognitiveservices/OpenAI.Inference
+Version: 1.0.0
+Generation Type: mgmt
+✓ Has Breaking Changes: No
+
+Changelog:
+### Features Added
+- New client `armcognitiveservices.ClientFactory` which is a client factory used to create any client in this module
+```
+
 ### The `issue` command
 
 The `issue` command fetches release request issues from `github.com/Azure/sdk-release-request/issues` and parses them into configuration that other commands consume. The configuration outputs to stdout.
@@ -64,17 +174,23 @@ The command outputs a JSON configuration:
 
 ### The `automation-v2` command
 
-The `automation-v2` command processes batch SDK generation for automation pipelines. This command is designed to run in the root directory of azure-sdk-for-go.
+The `automation-v2` command processes batch SDK generation for automation pipelines. This command is designed to run in the root directory of azure-sdk-for-go and handles multiple SDK generations in a single execution.
 
 **Usage:**
 ```bash
-generator automation-v2 <generate input filepath> <generate output filepath> [goVersion]
+generator automation-v2 <generate input filepath> <generate output filepath>
 ```
 
 **Arguments:**
 - `generate input filepath`: Path to the generation input JSON file
 - `generate output filepath`: Path where generation output JSON will be written
-- `goVersion`: Go version to use (default: "1.18")
+
+**What it does:**
+1. Reads the input configuration file containing specification details
+2. Processes multiple TypeSpec projects and README files
+3. Generates SDKs for all specified services
+4. Writes comprehensive output including generation results and errors
+5. Handles batch operations for CI/CD automation pipelines
 
 **Input Format:**
 The input file should contain:
@@ -90,9 +206,35 @@ The input file should contain:
 }
 ```
 
+**Output Format:**
+The command generates a JSON output file with generation results:
+```json
+{
+  "packages": [
+    {
+      "packageName": "armservice",
+      "path": "sdk/resourcemanager/service/armservice",
+      "readmeMd": "specification/service/resource-manager/readme.md",
+      "changelog": "### Features Added\n- Initial release",
+      "breaking": false
+    }
+  ],
+  "errors": []
+}
+```
+
+**Examples:**
+```bash
+# Process automation input file
+generator automation-v2 ./input.json ./output.json
+
+# Typical CI/CD usage
+generator automation-v2 /tmp/generation-input.json /tmp/generation-output.json
+```
+
 ### The `release-v2` command
 
-The `release-v2` command generates individual SDK releases for specific resource providers.
+The `release-v2` command generates individual SDK releases for specific resource providers. It creates new SDK packages or updates existing ones with new API versions.
 
 **Usage:**
 ```bash
@@ -115,61 +257,121 @@ generator release-v2 <azure-sdk-for-go directory> <azure-rest-api-specs director
 - `--skip-create-branch`: Skip creating release branch
 - `--skip-generate-example`: Skip generating examples
 - `--package-config`: Additional package configuration
-- `--go-version`: Go version (default: "1.18")
 - `-t, --token`: Personal access token for GitHub operations
 - `--tsp-config`: Path to TypeSpec tspconfig.yaml
 - `--tsp-option`: TypeSpec-go emit options (format: option1=value1;option2=value2)
 - `--tsp-client-option`: tsp-client options (e.g., --save-inputs, --debug)
 
+**What it does:**
+1. Creates or updates SDK packages for specified resource providers
+2. Generates Go client code from TypeSpec or Swagger specifications
+3. Creates appropriate changelogs and documentation
+4. Handles versioning and breaking change detection
+5. Optionally creates release branches for the changes
+
+**Examples:**
+```bash
+# Generate release for a specific RP
+generator release-v2 /path/to/azure-sdk-for-go /path/to/azure-rest-api-specs network
+
+# Generate with custom version and TypeSpec config
+generator release-v2 /path/to/azure-sdk-for-go /path/to/azure-rest-api-specs network \
+  --version-number v2.0.0 \
+  --tsp-config specification/network/tspconfig.yaml
+
+# Generate from release request config file
+generator release-v2 /path/to/azure-sdk-for-go /path/to/azure-rest-api-specs config.json
+
+# Skip branch creation and examples
+generator release-v2 /path/to/azure-sdk-for-go /path/to/azure-rest-api-specs compute \
+  --skip-create-branch --skip-generate-example
+```
+
 ### The `refresh-v2` command
 
-The `refresh-v2` command regenerates all existing SDK packages.
+The `refresh-v2` command regenerates all existing SDK packages using the latest specifications. This is useful for bulk updates across multiple packages.
 
 **Usage:**
 ```bash
-generator refresh-v2 <azure-sdk-for-go directory> <azure-rest-api-specs directory>
+generator refresh-v2 <azure-sdk-for-go directory> <azure-rest-api-specs directory> [flags]
 ```
 
+**Arguments:**
+- `azure-sdk-for-go directory`: Path to azure-sdk-for-go repository
+- `azure-rest-api-specs directory`: Path to azure-rest-api-specs repository
+
 **Flags:**
 - `--version-number`: Specify version number for refresh
 - `--sdk-repo`: SDK repository URL
 - `--spec-repo`: Spec repository URL  
 - `--release-date`: Release date for changelog
 - `--skip-create-branch`: Skip creating release branch
 - `--skip-generate-example`: Skip generating examples
-- `--go-version`: Go version (default: "1.18")
 - `--rps`: Comma-separated list of RPs to refresh (default: all)
 - `--update-spec-version`: Whether to update commit ID (default: true)
 
-### The `template` command
+**What it does:**
+1. Discovers all existing SDK packages in the repository
+2. Regenerates each package using current specifications
+3. Updates version numbers and changelogs as needed
+4. Handles batch processing of multiple resource providers
+5. Optionally creates release branches for all changes
+
+**Examples:**
+```bash
+# Refresh all existing packages
+generator refresh-v2 /path/to/azure-sdk-for-go /path/to/azure-rest-api-specs
+
+# Refresh specific resource providers only
+generator refresh-v2 /path/to/azure-sdk-for-go /path/to/azure-rest-api-specs \
+  --rps network,compute,storage
+
+# Refresh without creating branches or examples
+generator refresh-v2 /path/to/azure-sdk-for-go /path/to/azure-rest-api-specs \
+  --skip-create-branch --skip-generate-example
+
+# Refresh with custom version and release date
+generator refresh-v2 /path/to/azure-sdk-for-go /path/to/azure-rest-api-specs \
+  --version-number v1.1.0 --release-date 2024-01-15
+```
 
-The `template` command generates package templates and scaffolding for new SDK packages.
+### The `template` command
 
-## TypeSpec Support
+The `template` command generates package templates and scaffolding for new SDK packages. It creates the necessary directory structure and boilerplate code to onboard new services to the Azure SDK for Go.
 
-The generator supports both traditional Swagger/OpenAPI specifications and modern TypeSpec definitions:
+**Usage:**
+```bash
+generator template <service-name> [flags]
+```
 
-### TypeSpec Generation
-- Uses `@azure-tools/typespec-client-generator-cli` (tsp-client) v0.21.0
-- Requires `tspconfig.yaml` with `@azure-tools/typespec-go` emitter configured
-- Supports both data-plane and management-plane TypeSpec projects
+**Arguments:**
+- `service-name`: Name of the service to create a template for
 
-### Swagger Generation  
-- Uses AutoRest with Go extensions
-- Processes `readme.go.md` configuration files
-- Supports management-plane SDK generation
+**Flags:**
+- `--output-dir`: Output directory for the generated template (default: current directory)
+- `--package-name`: Custom package name (default: derived from service name)
+- `--namespace`: Namespace for the service (default: arm + service name)
+- `--data-plane`: Generate data plane template instead of management plane
+- `--force`: Overwrite existing files if they exist
+
+**What it does:**
+1. Creates the standard Azure SDK for Go package directory structure
+2. Generates boilerplate Go files with proper package structure
+3. Creates example files and test scaffolding
+4. Sets up proper module configuration and dependencies
+5. Includes standard documentation templates
+
+**Examples:**
+```bash
+# Generate a management plane template for a new service
+generator template myservice
 
-## Prerequisites
+# Generate a data plane template
+generator template myservice --data-plane
 
-For full functionality, ensure you have:
+# Generate template with custom package name and output directory
+generator template myservice --package-name armmyservice --output-dir ./sdk/resourcemanager/myservice
 
-1. **Go 1.23 or later**
-2. **Node.js 20 or later** 
-3. **Generator tool**: Install with:
-   ```bash
-   go install github.com/Azure/azure-sdk-for-go/eng/tools/generator@latest
-   ```
-4. **tsp-client**: Install with:
-   ```bash
-   npm install -g @azure-tools/[email protected]
-   ```
+# Force overwrite existing files
+generator template myservice --force
+```