Skip to content

Commit fc3e71c

Browse files
Format skills using prettier (#47569)
Co-authored-by: Praveen Kuttappan <prmarott@microsoft.com>
1 parent 87bd487 commit fc3e71c

7 files changed

Lines changed: 58 additions & 55 deletions

File tree

.github/skills/azsdk-common-apiview-feedback-resolution/SKILL.md

Lines changed: 7 additions & 7 deletions
Original file line numberDiff line numberDiff line change
@@ -26,13 +26,13 @@ DO NOT USE FOR: general code review, non-APIView feedback
2626

2727
## MCP Tools
2828

29-
| Tool | Purpose |
30-
|------|---------|
31-
| `azure-sdk-mcp:azsdk_apiview_get_comments` | Get APIView comments |
32-
| `azure-sdk-mcp:azsdk_customized_code_update` | Apply TypeSpec & code customization changes locally |
33-
| `azure-sdk-mcp:azsdk_typespec_delegate_apiview_feedback` | Delegate to CCA pipeline |
34-
| `azure-sdk-mcp:azsdk_run_typespec_validation` | Validate TypeSpec |
35-
| `azure-sdk-mcp:azsdk_package_generate_code` | Regenerate SDK |
29+
| Tool | Purpose |
30+
| -------------------------------------------------------- | --------------------------------------------------- |
31+
| `azure-sdk-mcp:azsdk_apiview_get_comments` | Get APIView comments |
32+
| `azure-sdk-mcp:azsdk_customized_code_update` | Apply TypeSpec & code customization changes locally |
33+
| `azure-sdk-mcp:azsdk_typespec_delegate_apiview_feedback` | Delegate to CCA pipeline |
34+
| `azure-sdk-mcp:azsdk_run_typespec_validation` | Validate TypeSpec |
35+
| `azure-sdk-mcp:azsdk_package_generate_code` | Regenerate SDK |
3636

3737
## Steps
3838

.github/skills/azsdk-common-generate-sdk-locally/SKILL.md

Lines changed: 12 additions & 12 deletions
Original file line numberDiff line numberDiff line change
@@ -4,7 +4,7 @@ license: MIT
44
metadata:
55
version: "1.1.0"
66
distribution: shared
7-
description: "Generate, build, and test Azure SDKs locally from TypeSpec with automatic customization. WHEN: \"generate SDK locally\", \"build SDK\", \"run SDK tests\", \"run CI checks\", \"validate package\", \"run checks\", \"update changelog\", \"fix SDK build errors\", \"fix breaking changes\", \"resolve SDK generation errors\", \"customize TypeSpec\", \"rename SDK client\", \"rename SDK model\", \"hide operation from SDK\", \"fix analyzer errors\", \"resolve customization drift\", \"create subclient\", \"update metadata\", \"update version\". DO NOT USE FOR: publishing to package registries, CI pipeline configuration, API design review. INVOKES: azsdk_verify_setup, azsdk_package_generate_code, azsdk_package_build_code, azsdk_package_run_check, azsdk_package_run_tests, azsdk_customized_code_update, azsdk_package_update_changelog_content, azsdk_package_update_metadata, azsdk_package_update_version."
7+
description: 'Generate, build, and test Azure SDKs locally from TypeSpec with automatic customization. WHEN: "generate SDK locally", "build SDK", "run SDK tests", "run CI checks", "validate package", "run checks", "update changelog", "fix SDK build errors", "fix breaking changes", "resolve SDK generation errors", "customize TypeSpec", "rename SDK client", "rename SDK model", "hide operation from SDK", "fix analyzer errors", "resolve customization drift", "create subclient", "update metadata", "update version". DO NOT USE FOR: publishing to package registries, CI pipeline configuration, API design review. INVOKES: azsdk_verify_setup, azsdk_package_generate_code, azsdk_package_build_code, azsdk_package_run_check, azsdk_package_run_tests, azsdk_customized_code_update, azsdk_package_update_changelog_content, azsdk_package_update_metadata, azsdk_package_update_version.'
88
compatibility: "azure-sdk-mcp server, local azure-sdk-for-{language} clone, language build tools"
99
---
1010

@@ -26,17 +26,17 @@ DO NOT USE FOR: publishing to package registries, CI pipeline configuration, API
2626

2727
## MCP Tools
2828

29-
| Tool | Purpose |
30-
|------|---------|
31-
| `azure-sdk-mcp:azsdk_verify_setup` | Verify environment |
32-
| `azure-sdk-mcp:azsdk_package_generate_code` | Generate SDK |
33-
| `azure-sdk-mcp:azsdk_package_build_code` | Build package |
34-
| `azure-sdk-mcp:azsdk_package_run_check` | Validate package |
35-
| `azure-sdk-mcp:azsdk_package_run_tests` | Run tests |
36-
| `azure-sdk-mcp:azsdk_customized_code_update` | Apply customizations (includes regeneration and build) |
37-
| `azure-sdk-mcp:azsdk_package_update_changelog_content` | Update changelog |
38-
| `azure-sdk-mcp:azsdk_package_update_metadata` | Update metadata including ci.yml |
39-
| `azure-sdk-mcp:azsdk_package_update_version` | Update version |
29+
| Tool | Purpose |
30+
| ------------------------------------------------------ | ------------------------------------------------------ |
31+
| `azure-sdk-mcp:azsdk_verify_setup` | Verify environment |
32+
| `azure-sdk-mcp:azsdk_package_generate_code` | Generate SDK |
33+
| `azure-sdk-mcp:azsdk_package_build_code` | Build package |
34+
| `azure-sdk-mcp:azsdk_package_run_check` | Validate package |
35+
| `azure-sdk-mcp:azsdk_package_run_tests` | Run tests |
36+
| `azure-sdk-mcp:azsdk_customized_code_update` | Apply customizations (includes regeneration and build) |
37+
| `azure-sdk-mcp:azsdk_package_update_changelog_content` | Update changelog |
38+
| `azure-sdk-mcp:azsdk_package_update_metadata` | Update metadata including ci.yml |
39+
| `azure-sdk-mcp:azsdk_package_update_version` | Update version |
4040

4141
Prerequisites: azure-sdk-mcp server must be running. Without MCP, use `npx tsp-client` CLI.
4242

.github/skills/azsdk-common-generate-sdk-locally/references/customization-workflow.md

Lines changed: 21 additions & 20 deletions
Original file line numberDiff line numberDiff line change
@@ -6,15 +6,15 @@ The customization workflow is an AI-assisted process that applies TypeSpec decor
66

77
The customization tool (`azure-sdk-mcp:azsdk_customized_code_update`) can be triggered from multiple sources:
88

9-
| Entry Point | Description | Example |
10-
|-------------|-------------|---------|
11-
| **Build failures** | Compilation errors, analyzer violations, linting failures after SDK generation | `error CS0246: The type or namespace name 'FooModel' could not be found` |
12-
| **Breaking changes** | Output from breaking changes analysis tools detecting renamed/removed properties, changed types | `Breaking changes detected: FooOptions.timeout property type changed from int to Duration` |
13-
| **User prompts** | Natural language requests to modify SDK behavior | "Rename FooClient to BarClient for .NET" |
14-
| **API review feedback** | Feedback from APIView or PR comments on SDK naming/structure | "Model name doesn't follow .NET casing conventions" |
15-
| **.NET analyzer errors** | AZC0030 (naming violations), AZC0012 (generic type names), etc. | `AZC0030: Model name ends with 'Parameters'` |
16-
| **Customization drift** | Existing customization code references renamed/removed TypeSpec entities | `cannot find symbol: method getField(String)` |
17-
| **Duplicate field conflicts** | TypeSpec adds a property that already exists in manual customization code | `variable operationId is already defined in class AnalyzeOperationDetails` |
9+
| Entry Point | Description | Example |
10+
| ----------------------------- | ----------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------ |
11+
| **Build failures** | Compilation errors, analyzer violations, linting failures after SDK generation | `error CS0246: The type or namespace name 'FooModel' could not be found` |
12+
| **Breaking changes** | Output from breaking changes analysis tools detecting renamed/removed properties, changed types | `Breaking changes detected: FooOptions.timeout property type changed from int to Duration` |
13+
| **User prompts** | Natural language requests to modify SDK behavior | "Rename FooClient to BarClient for .NET" |
14+
| **API review feedback** | Feedback from APIView or PR comments on SDK naming/structure | "Model name doesn't follow .NET casing conventions" |
15+
| **.NET analyzer errors** | AZC0030 (naming violations), AZC0012 (generic type names), etc. | `AZC0030: Model name ends with 'Parameters'` |
16+
| **Customization drift** | Existing customization code references renamed/removed TypeSpec entities | `cannot find symbol: method getField(String)` |
17+
| **Duplicate field conflicts** | TypeSpec adds a property that already exists in manual customization code | `variable operationId is already defined in class AnalyzeOperationDetails` |
1818

1919
## When to Use
2020

@@ -44,17 +44,17 @@ The customization tool (`azure-sdk-mcp:azsdk_customized_code_update`) can be tri
4444

4545
## Common Scenarios
4646

47-
| Scenario | Phase | Customization |
48-
|----------|-------|--------------|
49-
| Type name conflict with reserved keyword | A | Rename via `@@clientName` in `client.tsp` |
50-
| Property renamed in new API version | A | Add `@@clientName` to preserve backward compatibility |
51-
| .NET analyzer error (AZC0030, AZC0012) | A | Apply scoped `@@clientName` decorators to fix naming violations |
52-
| Hide internal operation from SDK | A | Apply `@@access` decorator with language scope |
53-
| Create subclient architecture | A | Use `@client` and `@clientInitialization` decorators |
54-
| API review naming feedback | A | Apply scoped `@@clientName` for specific language |
55-
| Duplicate field from customization conflict | B | Remove duplicate `addField()` from customization class |
56-
| Customization references renamed property | B | Update references in `_patch.py`, `*Customization.java`, or partial classes |
57-
| Feature request with no TypeSpec solution | Manual | Tool provides guidance to create customization infrastructure |
47+
| Scenario | Phase | Customization |
48+
| ------------------------------------------- | ------ | --------------------------------------------------------------------------- |
49+
| Type name conflict with reserved keyword | A | Rename via `@@clientName` in `client.tsp` |
50+
| Property renamed in new API version | A | Add `@@clientName` to preserve backward compatibility |
51+
| .NET analyzer error (AZC0030, AZC0012) | A | Apply scoped `@@clientName` decorators to fix naming violations |
52+
| Hide internal operation from SDK | A | Apply `@@access` decorator with language scope |
53+
| Create subclient architecture | A | Use `@client` and `@clientInitialization` decorators |
54+
| API review naming feedback | A | Apply scoped `@@clientName` for specific language |
55+
| Duplicate field from customization conflict | B | Remove duplicate `addField()` from customization class |
56+
| Customization references renamed property | B | Update references in `_patch.py`, `*Customization.java`, or partial classes |
57+
| Feature request with no TypeSpec solution | Manual | Tool provides guidance to create customization infrastructure |
5858

5959
## Two-Phase Workflow
6060

@@ -70,6 +70,7 @@ When neither phase resolves the issue, or no customization files exist, the tool
7070
## Retry Logic
7171

7272
The tool handles retries internally with a two-pass classification approach:
73+
7374
1. First pass: classify feedback → apply TypeSpec fixes → regenerate → build
7475
2. Second pass: re-classify remaining items with build error context → apply code patches → rebuild
7576
3. If the tool response indicates build still failing, you can re-run `azure-sdk-mcp:azsdk_customized_code_update` with the updated error output

.github/skills/azsdk-common-generate-sdk-locally/references/detailed-workflow.md

Lines changed: 3 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -5,13 +5,15 @@
55
Determine the correct path to the TypeSpec configuration file based on the working context.
66

77
**Scenario A: Working in `azure-rest-api-specs`**
8+
89
- Identify the path to `tspconfig.yaml` (local path or HTTPS URL).
910
- The local folder name can be arbitrary; MCP validates that the remote origin points to the official repo.
1011
- Example paths:
1112
- `/home/usr/azure-rest-api-specs/specification/contosowidgetmanager/Contoso.Management/tspconfig.yaml`
1213
- `https://github.com/Azure/azure-rest-api-specs/blob/main/specification/contosowidgetmanager/Contoso.Management/tspconfig.yaml`
1314

1415
**Scenario B: Working in an Azure SDK language repo**
16+
1517
- Identify the path to `tsp-location.yaml`.
1618
- Example: `/home/usr/azure-sdk-for-net/sdk/contoso/Azure.ResourceManager.Contoso/tsp-location.yaml`
1719

@@ -22,7 +24,7 @@ There are two commit checkpoints in the workflow. At each one:
2224
1. Inform the user that the preceding steps completed successfully.
2325
2. **Prompt the user** to decide whether to commit now. Do NOT skip this prompt.
2426
3. If user chooses to commit:
25-
- Check if on the `main` branch. If so, prompt: *"You are currently on the main branch. Please create a new branch using `git checkout -b <branch-name>` before proceeding."* Suggest a default branch name (e.g., `sdk/<service-name>/<package-name>`).
27+
- Check if on the `main` branch. If so, prompt: _"You are currently on the main branch. Please create a new branch using `git checkout -b <branch-name>` before proceeding."_ Suggest a default branch name (e.g., `sdk/<service-name>/<package-name>`).
2628
- Stage changed files with `git add`.
2729
- Prompt for a commit message, then run `git commit -m "<message>"`.
2830
4. If user skips, acknowledge and proceed.

.github/skills/azsdk-common-generate-sdk-locally/references/sdk-repos.md

Lines changed: 11 additions & 11 deletions
Original file line numberDiff line numberDiff line change
@@ -18,17 +18,17 @@
1818

1919
## MCP Tools
2020

21-
| Tool | Purpose |
22-
|------|---------|
23-
| `azure-sdk-mcp:azsdk_verify_setup` | Verify local environment for selected language |
24-
| `azure-sdk-mcp:azsdk_package_generate_code` | Generate SDK from TypeSpec |
25-
| `azure-sdk-mcp:azsdk_package_build_code` | Build package |
26-
| `azure-sdk-mcp:azsdk_package_run_check` | Validate package |
27-
| `azure-sdk-mcp:azsdk_package_run_tests` | Run tests |
28-
| `azure-sdk-mcp:azsdk_customized_code_update` | Apply TypeSpec and code customizations to resolve build errors, breaking changes, or SDK modification requests (includes regeneration and build internally) |
29-
| `azure-sdk-mcp:azsdk_package_update_changelog_content` | Update changelog |
30-
| `azure-sdk-mcp:azsdk_package_update_metadata` | Update package metadata including ci.yml |
31-
| `azure-sdk-mcp:azsdk_package_update_version` | Update package version |
21+
| Tool | Purpose |
22+
| ------------------------------------------------------ | ----------------------------------------------------------------------------------------------------------------------------------------------------------- |
23+
| `azure-sdk-mcp:azsdk_verify_setup` | Verify local environment for selected language |
24+
| `azure-sdk-mcp:azsdk_package_generate_code` | Generate SDK from TypeSpec |
25+
| `azure-sdk-mcp:azsdk_package_build_code` | Build package |
26+
| `azure-sdk-mcp:azsdk_package_run_check` | Validate package |
27+
| `azure-sdk-mcp:azsdk_package_run_tests` | Run tests |
28+
| `azure-sdk-mcp:azsdk_customized_code_update` | Apply TypeSpec and code customizations to resolve build errors, breaking changes, or SDK modification requests (includes regeneration and build internally) |
29+
| `azure-sdk-mcp:azsdk_package_update_changelog_content` | Update changelog |
30+
| `azure-sdk-mcp:azsdk_package_update_metadata` | Update package metadata including ci.yml |
31+
| `azure-sdk-mcp:azsdk_package_update_version` | Update package version |
3232

3333
## Build Failure Resolution
3434

.github/skills/azsdk-common-pipeline-troubleshooting/SKILL.md

Lines changed: 3 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -4,7 +4,7 @@ license: MIT
44
metadata:
55
version: "1.0.0"
66
distribution: shared
7-
description: "Diagnose and resolve failures in Azure SDK CI and generation pipelines. **UTILITY SKILL**. USE FOR: \"pipeline failed\", \"build failure\", \"CI check failing\", \"SDK generation error\", \"reproduce pipeline locally\", \"debug SDK pipeline\". DO NOT USE FOR: local build issues without pipeline context, API design review, SDK publishing. INVOKES: azure-sdk-mcp:azsdk_analyze_pipeline, azure-sdk-mcp:azsdk_verify_setup, azure-sdk-mcp:azsdk_package_build_code, azure-sdk-mcp:azsdk_package_run_check, azure-sdk-mcp:azsdk_package_pack."
7+
description: 'Diagnose and resolve failures in Azure SDK CI and generation pipelines. **UTILITY SKILL**. USE FOR: "pipeline failed", "build failure", "CI check failing", "SDK generation error", "reproduce pipeline locally", "debug SDK pipeline". DO NOT USE FOR: local build issues without pipeline context, API design review, SDK publishing. INVOKES: azure-sdk-mcp:azsdk_analyze_pipeline, azure-sdk-mcp:azsdk_verify_setup, azure-sdk-mcp:azsdk_package_build_code, azure-sdk-mcp:azsdk_package_run_check, azure-sdk-mcp:azsdk_package_pack.'
88
compatibility: "azure-sdk-mcp server, Azure DevOps pipeline build ID"
99
---
1010

@@ -26,8 +26,8 @@ DO NOT USE FOR: local build issues without pipeline context, API design review,
2626

2727
## MCP Tools
2828

29-
| Tool | Purpose |
30-
| -------------------------- | ------------------------ |
29+
| Tool | Purpose |
30+
| ---------------------------------------- | ------------------------ |
3131
| `azure-sdk-mcp:azsdk_analyze_pipeline` | Analyze pipeline failure |
3232
| `azure-sdk-mcp:azsdk_verify_setup` | Verify local environment |
3333
| `azure-sdk-mcp:azsdk_package_build_code` | Reproduce build locally |

.github/skills/azsdk-common-prepare-release-plan/references/release-plan-details.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -53,4 +53,4 @@ For first release of management plane SDK:
5353
If SDK PRs exist:
5454

5555
1. Ensure GitHub CLI authentication (`gh auth login`)
56-
2. Run `azsdk_link_sdk_pull_request_to_release_plan` for each PR, passing the Release Plan ID or work item ID as `workItemId` (or as `releasePlanId`) — either value is accepted.
56+
2. Run `azsdk_link_sdk_pull_request_to_release_plan` for each PR, passing the Release Plan ID or work item ID as `workItemId` (or as `releasePlanId`) — either value is accepted.

0 commit comments

Comments
 (0)