create-api-review

Stars5,583

Forks3,346

UpdatedJuly 30, 2026 at 19:24

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.

Installation

Install with Codex or Claude Copy this prompt, paste it into Codex, Claude, or another assistant, and let it review the skill page and install it for you.

Source

Azure

Azure/azure-sdk-for-python

View GitHub Repository View Creator Repositories

Download

Related occupationsSOC

Based on SOC occupation classification

Software DevelopersComputer and Mathematical Occupations·SOC 15-1252

SKILL.md

readonly

name	create-api-review
license	MIT
metadata	{"version":"1.0.0","distribution":"shared"}
description	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.
compatibility	azure-sdk-mcp server v0.6.32 or later

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.

More from this repository

same repository

azure-ai-projects-emit-from-typespec

Azure/azure-sdk-for-python

Emit the azure-ai-projects Python SDK from TypeSpec, apply post-emitter fixes, and create a Pull Request. WHEN: "emit SDK from TypeSpec", "generate azure-ai-projects SDK", "update azure-ai-projects from TypeSpec", "emit from TypeSpec", "regenerate azure-ai-projects". DO NOT USE FOR: other Azure SDK packages, manual code edits without TypeSpec. INVOKES: PostEmitter.ps1 script, git commands, gh CLI for PR creation.

2026-07-255.6k

azure-ai-projects-update-changelog

Azure/azure-sdk-for-python

Update CHANGELOG.md by comparing public APIs between the current branch and the latest released version on PyPI. WHEN: "update changelog", "generate changelog", "add changelog entry", "what changed in this version". DO NOT USE FOR: other Azure SDK packages. INVOKES: PyPI API, GitHub API (for tags), file operations.

2026-07-255.6k

azsdk-common-eval-authoring-skill

Azure/azure-sdk-for-python

Author and validate Vally evals for Agent Skills under .github/skills. WHEN: "write a skill eval", "add trigger eval", "test skill routing", "add anti-trigger tests", "create skill capability eval", "harden skill graders". DO NOT USE FOR: single MCP tool prompt-to-tool coverage (use azsdk-common-eval-authoring-tool), multi-tool or multi-turn scenarios (use azsdk-common-eval-authoring-workflow), authoring SKILL.md itself (use skill-authoring).

2026-07-235.6k

azsdk-common-eval-authoring-tool

Azure/azure-sdk-for-python

Author and validate hermetic single-tool Vally evals under evals/tools. WHEN: "write a tool eval", "add prompt-to-tool coverage", "test MCP tool selection", "add tool catalog eval", "create single-tool scenario", "harden tool-call grader". DO NOT USE FOR: skill routing or capability evals (use azsdk-common-eval-authoring-skill), multi-tool, multi-turn, or live scenarios (use azsdk-common-eval-authoring-workflow).

2026-07-235.6k

azsdk-common-eval-authoring-workflow

Azure/azure-sdk-for-python

Author and validate multi-tool, multi-turn, mock, and live Vally scenarios under evals/workflows. WHEN: "write a workflow eval", "add end-to-end eval", "test tool sequence", "create multi-turn eval", "add mock workflow scenario", "add live eval". DO NOT USE FOR: per-skill routing/capability evals (use azsdk-common-eval-authoring-skill), isolated prompt-to-tool tests (use azsdk-common-eval-authoring-tool).

2026-07-235.6k

emitter-package-update

Azure/azure-sdk-for-python

Automate updating the emitter package dependencies in eng/emitter-package.json for the Azure SDK for Python repository, then open a PR. Use this skill when the user wants to update @azure-tools/typespec-python (or any other dependency in emitter-package.json) to the latest version, create a PR for an emitter-package version bump, or manage emitter-package.json updates.

2026-07-155.6k

name	create-api-review
license	MIT
metadata	{"version":"1.0.0","distribution":"shared"}
description	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.
compatibility	azure-sdk-mcp server v0.6.32 or later

Create API Review

This skill creates an API review pull request through API Review Hub for a package API surface comparison.

Triggers

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.