Create API Review
This skill creates an API review pull request through API Review Hub for a package API surface comparison.
Triggers
USE FOR: create API review, open API review, compare package versions, APIView PR
WHEN: "create API review", "open API review", "compare package versions", "APIView PR"
DO NOT USE FOR: fixing APIView comments, SDK code generation, pipeline debugging
Rules
- Requires
azure-sdk-mcp version 0.6.32 or later.
- Use
azure-sdk-mcp:azsdk_apireviewhub_request_review_pr to create the review PR.
- CLI equivalent is
azsdk api-review create.
- Language is fixed to
python for this repository.
- Required user inputs:
packageName, targetBranch.
baseTag defines the baseline version. Use package tag format: <packageName>_<version>.
- If
baseTag is omitted, ask the user to choose one of:
- Use the latest GA (non-beta) release tag for
packageName.
- Provide a specific tag or version to use as baseline.
- Direct MCP calls require
targetRepo: azure-sdk-for-python; targetOwner defaults to Azure unless explicitly provided (for example, a fork), so pass both explicitly when overriding defaults.
- The CLI may supply repository defaults, but the MCP method does not.
targetOwner, targetRepo, and targetBranch define where the review PR branch is created.
- Wait behavior mapping:
--no-wait corresponds to waitForCompletion: false.
- Poll behavior mapping:
--poll-interval-seconds corresponds to pollIntervalSeconds (default 30).
- Optionally provide a ready-to-run
azsdk api-review create command for the user with resolved values.
MCP Tools
| Tool |
Purpose |
azure-sdk-mcp:azsdk_apireviewhub_request_review_pr |
Create API review PR request |
azure-sdk-mcp:azsdk_upgrade |
Check/upgrade MCP server version |
Steps
- Collect Inputs - Get required
packageName and targetBranch. Optionally collect baseTag.
- Prompt For Baseline - If
baseTag is not provided, ask the user to choose latest GA (non-beta) or provide a specific tag/version.
- Resolve Baseline - If the user chooses latest GA, resolve and use the latest GA (non-beta) release tag for
packageName. If the user provides a tag/version, use that value.
- Validate MCP Version - Ensure
azure-sdk-mcp is 0.6.32+.
- Set Wait Mode - Default to wait for completion. Use
waitForCompletion: false only when user asks for no-wait behavior.
- Set Poll Interval - If waiting for completion, use
pollIntervalSeconds (default 30, override only if requested).
- Request Review PR - Run
azure-sdk-mcp:azsdk_apireviewhub_request_review_pr with language: python, targetRepo: azure-sdk-for-python, and targetOwner (default Azure unless explicitly provided), plus collected inputs.
- Return Result - Provide review PR URL and operation status.
- Optional CLI Output - If useful or requested, provide the equivalent
azsdk api-review create command with all resolved arguments.
CLI Command Template
azsdk api-review create `
--language python `
--package-name <packageName> `
--base-tag <baseTag> `
--target-branch <targetBranch> `
--target-owner <targetOwner> `
--target-repo <targetRepo>
Optional flags:
--no-wait
--poll-interval-seconds 30
--output plain|json
Example
For azure-storage-blob comparing 1.0.0 to the latest on main:
packageName: azure-storage-blob
baseTag: azure-storage-blob_1.0.0
targetOwner: Azure
targetRepo: azure-sdk-for-python
targetBranch: main
Troubleshooting
- If tool is missing or unsupported, run
azure-sdk-mcp:azsdk_upgrade with checkOnly: true to verify current version.
- If
baseTag is invalid, confirm the exact release tag name in the repository.
- If
baseTag is omitted, confirm the user's baseline choice before requesting the review PR.
- If the generated review does not reflect expected changes, confirm
targetBranch contains the intended newer API surface.
1---2name: create-api-review3license: MIT4metadata:5 source: https://skillmd.com/skills/azure-azure-sdk-for-python/create-api-review6 version: "1.0.0"7 distribution: shared8description: 'Create an API review PR for an Azure SDK package using API Review Hub. **UTILITY SKILL**. USE FOR: "create API review", "open API review", "compare package versions", "APIView PR". DO NOT USE FOR: fixing APIView comments, SDK code generation, pipeline debugging. INVOKES: azure-sdk-mcp:azsdk_apireviewhub_request_review_pr.'9compatibility: "azure-sdk-mcp server v0.6.32 or later"10---1112# Create API Review1314This skill creates an API review pull request through API Review Hub for a package API surface comparison.1516## Triggers1718USE FOR: create API review, open API review, compare package versions, APIView PR19WHEN: "create API review", "open API review", "compare package versions", "APIView PR"20DO NOT USE FOR: fixing APIView comments, SDK code generation, pipeline debugging2122## Rules2324- Requires `azure-sdk-mcp` version `0.6.32` or later.25- Use `azure-sdk-mcp:azsdk_apireviewhub_request_review_pr` to create the review PR.26- CLI equivalent is `azsdk api-review create`.27- Language is fixed to `python` for this repository.28- Required user inputs: `packageName`, `targetBranch`.29- `baseTag` defines the baseline version. Use package tag format: `<packageName>_<version>`.30- If `baseTag` is omitted, ask the user to choose one of:31 - Use the latest GA (non-beta) release tag for `packageName`.32 - Provide a specific tag or version to use as baseline.33- Direct MCP calls require `targetRepo: azure-sdk-for-python`; `targetOwner` defaults to `Azure` unless explicitly provided (for example, a fork), so pass both explicitly when overriding defaults.34- The CLI may supply repository defaults, but the MCP method does not.35- `targetOwner`, `targetRepo`, and `targetBranch` define where the review PR branch is created.36- Wait behavior mapping: `--no-wait` corresponds to `waitForCompletion: false`.37- Poll behavior mapping: `--poll-interval-seconds` corresponds to `pollIntervalSeconds` (default `30`).38- Optionally provide a ready-to-run `azsdk api-review create` command for the user with resolved values.3940## MCP Tools4142| Tool | Purpose |43| ----------------------------------------------------- | ------------------------------- |44| `azure-sdk-mcp:azsdk_apireviewhub_request_review_pr` | Create API review PR request |45| `azure-sdk-mcp:azsdk_upgrade` | Check/upgrade MCP server version |4647## Steps48491. **Collect Inputs** - Get required `packageName` and `targetBranch`. Optionally collect `baseTag`.502. **Prompt For Baseline** - If `baseTag` is not provided, ask the user to choose latest GA (non-beta) or provide a specific tag/version.513. **Resolve Baseline** - If the user chooses latest GA, resolve and use the latest GA (non-beta) release tag for `packageName`. If the user provides a tag/version, use that value.524. **Validate MCP Version** - Ensure `azure-sdk-mcp` is `0.6.32+`.535. **Set Wait Mode** - Default to wait for completion. Use `waitForCompletion: false` only when user asks for no-wait behavior.546. **Set Poll Interval** - If waiting for completion, use `pollIntervalSeconds` (default `30`, override only if requested).557. **Request Review PR** - Run `azure-sdk-mcp:azsdk_apireviewhub_request_review_pr` with `language: python`, `targetRepo: azure-sdk-for-python`, and `targetOwner` (default `Azure` unless explicitly provided), plus collected inputs.568. **Return Result** - Provide review PR URL and operation status.579. **Optional CLI Output** - If useful or requested, provide the equivalent `azsdk api-review create` command with all resolved arguments.5859## CLI Command Template6061```powershell62azsdk api-review create `63 --language python `64 --package-name <packageName> `65 --base-tag <baseTag> `66 --target-branch <targetBranch> `67 --target-owner <targetOwner> `68 --target-repo <targetRepo>69```7071Optional flags:7273- `--no-wait`74- `--poll-interval-seconds 30`75- `--output plain|json`7677## Example7879For `azure-storage-blob` comparing `1.0.0` to the latest on main:8081- `packageName`: `azure-storage-blob`82- `baseTag`: `azure-storage-blob_1.0.0`83- `targetOwner`: `Azure`84- `targetRepo`: `azure-sdk-for-python`85- `targetBranch`: `main`8687## Troubleshooting8889- If tool is missing or unsupported, run `azure-sdk-mcp:azsdk_upgrade` with `checkOnly: true` to verify current version.90- If `baseTag` is invalid, confirm the exact release tag name in the repository.91- If `baseTag` is omitted, confirm the user's baseline choice before requesting the review PR.92- If the generated review does not reflect expected changes, confirm `targetBranch` contains the intended newer API surface.