azure-typespec-author

Azure TypeSpec Author

MCP Tools

Prerequisite: azure-sdk-mcp server must be running.

When to invoke the azure-typespec-author skill

The azure-typespec-author skill must be invoked immediately in all modes (including plan mode) for any task that involves creating and modifying TypeSpec (.tsp) files except for client.tsp under the specification directory in this repository. This includes but is not limited to:

• Adding, bumping, or promoting API versions (preview, stable)
• Adding or modifying resources, operations, models, properties, or decorators
• Changing visibility, constraints, breaking changes, LRO patterns, or suppressions
• Defining or updating operationId, spread models, or extension resources
• Converting Swagger to TypeSpec (post-conversion edits)

Constraints

• Always follow the full workflow — even seemingly simple changes (e.g. adding a default value) can require complex versioning decorator changes. Never skip steps.
• Mandatory for ALL .tsp edits — even a single ? change can be breaking.
• Minimal, scoped edits — only change what the request requires.
• Always validate — run every steps in validation after every edit.
• Always cite references — provide links that justify the approach.
• Follow the authoring plan exactly — code changes in Step 4 MUST follow the authoring plan generated in Step 3. Do not deviate by referring to existing code patterns in the TypeSpec project; the authoring plan is the single source of truth for what to change.

Workflow

Analyze → Intake → Plan → Apply → Validate → Output reference links

• Step 1 — Analyze project
• Step 2 — Intake
• Step 3 — Build authoring plan
• Step 4 — Apply changes
• Step 5 — Validate
• Step 6 — Output reference links

Step 1: Analyze Project

See analyze-project.md.

Step 2: Intake

See intake.md.

Step 3: Build Authoring Plan

See authoring-plan.md.

Step 4: Apply Changes

Make minimal .tsp edits following the plan from Step 3. Confirm uncertainties with the user first.

Step 5: Validate

See validation.md. Run 5.1 (TypeSpec validation) and 5.2 (tsp compile .) always; 5.3 (example verification) for API version evolution only.

Step 6: Output Reference Links

Output all referenced document URLs from Step 3. This gives the user direct links to the documentation that informed the changes.

Reference Files

Examples

• "Add a new preview API version 2026-01-01-preview for widget resource manager"
• "Add an ARM resource named Asset with CRUD operations"
• "Add a new property to the Widget model"