Azure Typespec Author
Developmentazure-typespec-authorAzure Typespec Author is an Agent Skill for development published in the Azure/azure-rest-api-specs repository on GitHub: a SKILL.md instruction file an AI agent can load to do this task.
Authors and modifies Azure TypeSpec (.tsp) API specifications. USE FOR: any TypeSpec/tsp change — api versions (add, bump, preview, stable, promote), resources, operations, models, properties, decorators, visibility, constraints, breaking changes, LRO, suppressions, operationId, spread model. Covers ARM resource-manager and data-plane services. DO NOT USE FOR: SDK generation, releasing SDK packages, or single MCP tool calls. INVOKES: azure-sdk-mcp:azsdk_typespec_generate_authoring_plan, azure-sdk-mcp:azsdk_run_typespec_validation.
How to use this skill
Bring this guide into your coding agent with a prompt tailored to the tool you use.
- Open your project in Codex.
- Copy and paste the prompt below.
- Review files and risks before approving any action.
Inspect the Agent Skill at https://github.com/Azure/azure-rest-api-specs/blob/HEAD/.github/skills/azure-typespec-author/SKILL.md and all supporting files. Report provenance, permissions, scripts, dependencies, and security risks. Propose an exact installation into .agents/skills/azure-typespec-author, but wait for my approval before writing files or running scripts.
Copying this prompt does not install or run the skill. Review third-party files before use.
Azure TypeSpec Author
MCP Tools
| Tool | Purpose |
|---|---|
azure-sdk-mcp:azsdk_typespec_generate_authoring_plan | Generate grounded authoring plan (General Authoring only) |
azure-sdk-mcp:azsdk_run_typespec_validation | Validate TypeSpec |
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
.tspedits — 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
| File | Purpose |
|---|---|
| analyze-project.md | Step 1: project analysis |
| intake.md | Step 2: general + case-specific intake |
| authoring-plan.md | Step 3: build authoring plan (Option A + B) |
| agentic-search.md | Procedure: fetch URLs → extract guidance |
| reference-document-links.md | Catalog of external guide URLs |
| validation.md | Step 5: validate → compile → verify |
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"