1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
|
---
description: "Guide the user to generate and build SDKs locally for a TypeSpec based API spec"
---
# Goal
Help the user generate and build SDKs locally from TypeSpec API specifications using the `azure-sdk-mcp` tools.
---
## Part A: Generate SDK Locally
### Step 1: Outline workflow
**Goal**: Ensure the user understands the overall SDK generation and build process before starting.
**Actions**:
- Present the high-level steps involved in generating and building SDK locally:
1. Select target language
2. Verify SDK repository
3. Validate repository path
4. Identify path to configuration file
5. Generate SDK using `azsdk_package_generate_code` MCP tool
6. Identify SDK project path
7. Build/Compile SDK using `azsdk_package_build_code` MCP tool
- Ask the user to confirm readiness to proceed.
---
### Step 2: Select language
**Goal**: Confirm the target language for SDK generation.
**Actions**:
- Prompt user to choose one of the supported languages:
- .NET
- Java
- JavaScript
- Python
- Go
- Validate input against the allowed list.
---
### Step 3: Verify SDK repository
**Goal**: Ensure the correct Azure SDK language repository is available locally.
**Actions**:
- Prompt user to provide the path to their **locally cloned repository** for the selected language.
- Note: The **local folder name can be arbitrary**, but the repository must have originated from one of the official Azure SDK repositories:
- `azure-sdk-for-net` (.NET)
- `azure-sdk-for-java` (Java)
- `azure-sdk-for-js` (JavaScript)
- `azure-sdk-for-python` (Python)
- `azure-sdk-for-go` (Go)
- If the repository is not cloned → instruct user to clone the appropriate remote repository from GitHub.
- MCP tool will automatically validate the remote origin and repository structure.
---
### Step 4: Validate repository path
**Actions**:
- Check if the provided repository path exists and matches the selected SDK language repository.
- If invalid → prompt user to re-enter a valid path.
---
### Step 5: Identify path to configuration file
**Goal**: Determine the correct path to the TypeSpec configuration file based on the working context.
**Actions**:
- **Scenario A: Working in a repository cloned from `azure-rest-api-specs`**
- Identify the path to `tspconfig.yaml` (local path or HTTPS URL).
- The local folder name can be arbitrary; the MCP tool will validate that the remote origin URL points to the official `azure-rest-api-specs` repository.
- Example paths (pointing directly to tspconfig.yaml):
- `/home/usr/azure-rest-api-specs/specification/contosowidgetmanager/Contoso.Management/tspconfig.yaml`
- `https://github.com/Azure/azure-rest-api-specs/blob/4af373fc5826cf5a2365a20dde01c4b2efde48f0/specification/contosowidgetmanager/Contoso.Management/tspconfig.yaml`
- **Scenario B: Working in one of the official Azure SDK language repositories**
(i.e., originally cloned from `azure-sdk-for-net`, `azure-sdk-for-java`, `azure-sdk-for-js`, `azure-sdk-for-python`, `azure-sdk-for-go`)
- Identify the path to `tsp-location.yaml`.
- The local folder name can be arbitrary; MCP tool will validate the remote origin URL.
- Example path:
`/home/usr/azure-sdk-for-net/sdk/contoso/Azure.ResourceManager.Contoso/tsp-location.yaml`
---
### Step 6: Generate SDK
**Actions**:
- Run `azsdk_package_generate_code` MCP tool to generate the SDK locally.
---
## Part B: Build / Compile SDK Locally
### Step 1: Identify SDK project path
**Goal**: Locate the generated SDK project directory for building/compiling.
**Actions**:
- Find the project directory inside the selected Azure SDK language repository.
- Typical structure:
`sdk/{service-name}/{package-name}/`
- Example:
`/path/to/azure-sdk-for-net/contoso/Azure.ResourceManager.Contoso/`
---
### Step 2: Build/Compile the SDK
**Actions**:
- Run `azsdk_package_build_code` MCP tool to compile the SDK in the identified project directory.
|
