Official agent skill

Azure Typespec Author

by Azure in Azure/azure-sdk-tools

Authors and modifies Azure TypeSpec (.tsp) API specifications.

OfficialMITAuto-check passedAgent Workflows

Install Azure Typespec Author

skills CLI
$ npx skills add Azure/azure-sdk-tools --skill azure-typespec-author -a claude-code

Project install by default; add -g for ~/.claude/skills/.

GitHub CLI
$ gh skill install Azure/azure-sdk-tools azure-typespec-author --agent claude-code

Project scope by default; add --scope user for a personal install. Needs GitHub CLI 2.90.0 or later (public preview).

Manual copy
$ git clone --depth 1 https://github.com/Azure/azure-sdk-tools.git skills-src && mkdir -p .claude/skills && cp -r skills-src/.github/skills/azure-typespec-author .claude/skills/azure-typespec-author && rm -rf skills-src

Use ~/.claude/skills/ instead of .claude/skills for a personal install. The folder must contain SKILL.md.

Claude Code skills documentation · loads skills from .claude/skills/

Facts

Skill name
azure-typespec-author
GitHub stars
134
Token cost
~1.9k tokens
SKILL.md length
717 words
Files
330 (incl. references)
Skills in repo
35
Repo updated
First seen
Licence
MIT

At a glance

Authors and modifies Azure TypeSpec (.tsp) API specifications.

  • Works in 6 steps: Analyze Project → Intake → Build Authoring Plan → …
  • : any TypeSpec/tsp change — api versions (add
  • SKILL.md covers Triggers, MCP Tools, Rules and Steps, plus 2 more sections
  • Runs JavaScript scripts from its folder

What it does

Azure Typespec Author is an agent skill from Azure/azure-sdk-tools, published by the product's own GitHub organization. Authors and modifies Azure TypeSpec (.tsp) API specifications. MUST BE USED FOR ALL TypeSpec changes regardless of complexity — even adding a single property or enum value requires this skill's validation workflow. 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 both ARM resource-manager (Azure.ResourceManager) and data-plane…

Its SKILL.md is about 1.9k tokens, which your agent loads only when the skill is triggered. The skill folder holds 333 other files, including reference files (for example `agentic-doc-refinement/README.md`, `agentic-doc-refinement/package-lock.json` and `agentic-doc-refinement/package.json`). Compatibility notes: azure-sdk-mcp server with azure-sdk-mcp:azsdktypespecretrieveknowledge and azure-sdk-mcp:azsdkruntypespecvalidation tools

It sits in Agent Workflows, covering MCP servers and OpenAPI specifications. It works with Microsoft Azure and Model Context Protocol. The repository describes itself as: Tools repository leveraged by the Azure SDK team. The licence is MIT.

When your agent uses it

  • : any TypeSpec/tsp change — api versions (add
  • Breaking changes
  • : SDK generation
  • Releasing SDK packages

Example prompts

  • “Use the azure-typespec-author skill to author and modifies Azure TypeSpec (.tsp) API specifications”
  • “/azure-typespec-author”

Requirements

  • Node.js
  • Compatibility (from SKILL.md): azure-sdk-mcp server with azure-sdk-mcp:azsdk_typespec_retrieve_knowledge and azure-sdk-mcp:azsdk_run_typespec_validation tools

Workflow steps

6 steps, taken from the step headings in SKILL.md.

  1. Analyze Project
  2. Intake
  3. Build Authoring Plan
  4. Apply Changes
  5. Validate
  6. Output Reference Links

What it can do on your machine

Read from SKILL.md and the folder at commit cc5ca24. It shows what the files ask for, not the result of running them.

  • Tool permissions

    Pre-approves nothing: there is no allowed-tools line, so your agent's usual permission prompts apply.

    From allowed-tools in the SKILL.md frontmatter.

  • Runs code

    Ships script files (JavaScript, from the files we listed), which the agent can run.

    From the folder's file list and the shell code blocks in SKILL.md.

  • Network

    No URLs in SKILL.md.

    From URLs in SKILL.md, links to its own repository left out.

  • Credentials

    Names no API keys, tokens, secrets or passwords.

    From names ending in _API_KEY, _TOKEN, _SECRET, _KEY or _PASSWORD in SKILL.md.

  • Compatibility

    azure-sdk-mcp server with azure-sdk-mcp:azsdk_typespec_retrieve_knowledge and azure-sdk-mcp:azsdk_run_typespec_validation tools

    From compatibility in the SKILL.md frontmatter.

Context cost

Azure Typespec Author loads about 1.9k tokens when it runs, and up to ~7k if it reads all its reference files. Until then it costs about 187 tokens; SKILL.md has 717 words of instructions outside code blocks.

Always · name and description, kept in context so the agent knows when to use it
~187
When it runs · the whole SKILL.md, loaded when a task matches
~1.9k
With references · SKILL.md plus every file in references/, read only if the agent opens them
~7k

Estimates: characters ÷ 4, the usual rule of thumb; real counts depend on the model's tokenizer. Scripts and assets cost tokens only if the agent reads them.

Safety

Auto-check passed

The automated check found no risky patterns in SKILL.md.

Automated static check — not a guarantee. Review scripts before installing. It scans the text of SKILL.md for risky patterns (piping downloads into a shell, reading credential files, hidden Unicode, destructive commands); files beside SKILL.md are not scanned.

SKILL.md

The full file from Azure/azure-sdk-tools at commit cc5ca24, republished under its MIT licence (© Azure). 717 words, ~1,947 tokens.

Download SKILL.mdSave it as .claude/skills/azure-typespec-author/SKILL.md (or your agent's skills folder). This skill also uses 329 other files; get the full folder from GitHub.
name
azure-typespec-author
description
Authors and modifies Azure TypeSpec (.tsp) API specifications. MUST BE USED FOR ALL TypeSpec changes regardless of complexity — even adding a single property or enum value requires this skill's validation workflow. 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 both ARM resource-manager (Azure.ResourceManager) and data-plane (Azure.Core) services. DO NOT USE FOR: SDK generation, releasing SDK packages, or single MCP tool calls. INVOKES: azure-sdk-mcp:azsdk_typespec_retrieve_knowledge, azure-sdk-mcp:azsdk_run_typespec_validation.
compatibility
azure-sdk-mcp server with azure-sdk-mcp:azsdk_typespec_retrieve_knowledge and azure-sdk-mcp:azsdk_run_typespec_validation tools
license
MIT
metadata.version
1.0.0

Azure TypeSpec Author

This skill authors and modifies Azure TypeSpec (.tsp) API specifications for ARM resource-manager and data-plane services, covering versioning, resources, operations, models, decorators, constraints, and other schema changes that must follow the repository's TypeSpec authoring workflow.

Triggers

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 WHEN: "add TypeSpec API version", "modify .tsp file", "change TypeSpec decorators", "update TypeSpec models or operations", "author Azure TypeSpec" DO NOT USE FOR: SDK generation, releasing SDK packages, or single MCP tool calls

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 skill MUST be used regardless of how simple the task appears — there are no "simple" TypeSpec edits. Even trivial-seeming changes (adding a single enum value, one property, one operation) require the full workflow because versioning decorators, validation, and compliance checks are mandatory.

This includes but is not limited to:

  • Adding, bumping, or promoting API versions (preview, stable) for ARM or data-plane services
  • 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)

MCP Tools

ToolPurpose
azure-sdk-mcp:azsdk_typespec_retrieve_knowledgeRetrieve knowledge for requests not covered by the eight cases in reference-document-links.md. Covered cases use agentic search (web_fetch) instead.
azure-sdk-mcp:azsdk_run_typespec_validationValidate TypeSpec

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

Rules

  • Do NOT skip this skill for "simple" tasks — there are no simple TypeSpec edits. A single property addition can require @added decorators, version gating, and validation. Always invoke this skill.
  • 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.

Steps

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
Show full SKILL.md (284 more words)Show less
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. Always run 5.1 general validation (5.1.1 TypeSpec validation and 5.1.2 tsp compile .); run 5.2 case-specific validation whenever its case matches.

Output the validation results as a checklist. Report one line per check, each marked ✅ (pass) or ❌ (fail) with a short note. Fix every ❌ and re-run until all checks pass. For API Versioning (Case 3) the checklist must cover every §5.2 Case 3 check — including: the new version's examples/ folder exists; no example folder remains for a version absent from the Versions enum; no decorator references a version absent from the enum; every carried-over feature is present with its decorators rebased onto the new version (not reverted); every excluded feature is fully removed.

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

Reference Files

FilePurpose
analyze-project.mdStep 1: project analysis
intake.mdStep 2: general + case-specific intake
authoring-plan.mdStep 3: build authoring plan (Option A + B)
agentic-search.mdProcedure: fetch URLs → extract guidance
reference-document-links.mdCatalog of external guide URLs
validation.mdStep 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"
  • "Add a list operation for the WidgetSuite resource using Azure.Core templates"
  • "Add a new preview API version to a data-plane service"
  • "Create a data-plane resource interface with full CRUD and list operations"

© Azure, MIT. Rendered from Markdown: HTML in the file is shown as text, images as links, and headings moved down two levels. Raw file

Files

SKILL.md and 329 other files (references) in .github/skills/azure-typespec-author of Azure/azure-sdk-tools.

  • SKILL.md
  • agentic-doc-refinement/README.md
  • agentic-doc-refinement/doc-refinement.mjs
  • agentic-doc-refinement/package-lock.json
  • agentic-doc-refinement/package.json
  • agentic-doc-refinement/prompts/01-update-reference-docs.md
  • agentic-doc-refinement/prompts/02-update-skill.md
  • agentic-doc-refinement/prompts/04-analyze-results.md
  • agentic-doc-refinement/prompts/05-generate-report.md
  • evaluate/.vally.yaml
  • evaluate/README.md
  • evaluate/evals/001001.eval.yaml
  • evaluate/evals/001002.eval.yaml
  • evaluate/evals/001003.eval.yaml
  • evaluate/evals/001004.eval.yaml
  • evaluate/evals/001005.eval.yaml
  • evaluate/evals/001006.eval.yaml
  • … and 313 more

Open the folder on GitHubat commit cc5ca24

Compare with similar skills

Azure Typespec Author next to the 5 skills that share the most tags, products or categories with it. Stars are the repository's; “used in” counts other GitHub owners with a copy.

Azure Typespec Author compared with similar skills
SkillStarsUsed inTokensAuto-checkLicenceRepo updated
Azure Typespec Author this skillAzure/azure-sdk-tools134—~1.9kAutomated safety check: PassMIT
Azure Aigatewaymicrosoft/GitHub-Copilot-for-Azure2551 repos~1.3kAutomated safety check: PassMIT
MCP Server Builderalirezarezvani/claude-skills28k—~985Automated safety check: PassMIT
Setupfcakyon/claude-codex-settings1.2k—~156Automated safety check: PassApache-2.0
MCP Server Builderborghei/Claude-Skills886—~1.9kAutomated safety check: PassMIT
Kingdee MCP DevWaHaiLong/KingdeeMCP105—~853Automated safety check: PassMIT

Similar skills

  • Azure Aigateway

    microsoft/GitHub-Copilot-for-Azure

    Official

    Configure Azure API Management as an AI Gateway for AI models, MCP tools, and agents.

    255 GitHub starsUsed in 1 repo~1.3k tokens
    Backend & APIsAuto-check passed
  • MCP Server Builder

    alirezarezvani/claude-skills

    Design and ship production-ready MCP (Model Context Protocol) servers from OpenAPI contracts instead of hand-written tool wrappers.

    28k GitHub stars~985 tokensUpdated 1 mo ago
    Agent WorkflowsAuto-check passed
  • Setup

    fcakyon/claude-codex-settings

    This skill should be used when user encounters "Azure MCP error", "Azure authentication failed", "az login required", "Azure CLI not found", or needs help configuring Azure MCP integration.

    1.2k GitHub stars~156 tokensUpdated yesterday
    Agent WorkflowsAuto-check passed
  • MCP Server Builder

    borghei/Claude-Skills

    Build MCP (Model Context Protocol) servers with tool definitions, resource providers, prompt templates, and transports.

    886 GitHub stars~1.9k tokensUpdated 2 days ago
    Agent WorkflowsAuto-check passed
  • Kingdee MCP Dev

    WaHaiLong/KingdeeMCP

    Knowledge base for the Kingdee MCP Dev Squad. An agent skill from WaHaiLong/KingdeeMCP.

    105 GitHub stars~853 tokensUpdated 1 mo ago
    Backend & APIsAuto-check passed
  • Generate MCP Server

    trycompai/comp

    A skill your agent uses when generating an MCP server from an OpenAPI spec with Speakeasy.

    2k GitHub stars~2.7k tokensUpdated yesterday
    Agent WorkflowsAuto-check passed

More from Azure/azure-sdk-tools

All 35 skills in this repo
  • Apiview Feedback Resolution

    Azure/azure-sdk-tools

    Official

    Analyze and resolve APIView review feedback on Azure SDK PRs.

    134 GitHub stars~547 tokensUpdated today
    Auto-check passed
  • Official

    Deploy test resources and run Azure SDK tests in live, record, or playback mode.

    134 GitHub stars~1.5k tokensUpdated today
    Auto-check: notes
  • Azsdk Common Pipeline Analysis

    Azure/azure-sdk-tools

    Official

    Analyze Azure SDK CI/CD pipeline failures into a structured diagnosis, and define the required output format.

    134 GitHub stars~1.2k tokensUpdated today
    Auto-check passed
  • Official

    Create, get, update, abandon, and link SDK PRs to release plan work items for Azure SDK releases.

    134 GitHub stars~2.7k tokensUpdated today
    Auto-check passed
  • Azure Typespec Assessment

    Azure/azure-sdk-tools

    Official

    Assess Azure TypeSpec Git diffs for semantic intent, REST and downstream SDK breaking changes, Azure Guidelines compliance, and documentation completeness.

    134 GitHub stars~1.9k tokensUpdated today
    Auto-check passed

Questions about Azure Typespec Author

What does Azure Typespec Author do?

Authors and modifies Azure TypeSpec (.tsp) API specifications. Azure Typespec Author is an agent skill from Azure/azure-sdk-tools, published by the product's own GitHub organization.tsp) API specifications.

When should I use Azure Typespec Author?

Azure Typespec Author fits situations like: : any TypeSpec/tsp change — api versions (add; breaking changes; : SDK generation; releasing SDK packages.

How do I install Azure Typespec Author in Claude Code?

Run `npx skills add Azure/azure-sdk-tools --skill azure-typespec-author -a claude-code`. Or copy the skill folder (.github/skills/azure-typespec-author in Azure/azure-sdk-tools) into .claude/skills/azure-typespec-author in your project. Claude Code loads it when a task matches its description.

How do I install Azure Typespec Author in Codex?

Run `npx skills add Azure/azure-sdk-tools --skill azure-typespec-author -a codex`. Or copy the skill folder (.github/skills/azure-typespec-author in Azure/azure-sdk-tools) into .agents/skills/azure-typespec-author in your project. Codex loads it when a task matches its description.

Can I use Azure Typespec Author in Cursor, Gemini CLI or GitHub Copilot?

Cursor, Gemini CLI, GitHub Copilot and OpenCode also load SKILL.md folders. With the skills CLI, run `npx skills add Azure/azure-sdk-tools --skill azure-typespec-author -a cursor` (or -a gemini-cli, github-copilot or opencode for the others). To copy it by hand, put the folder in .cursor/skills/azure-typespec-author, .gemini/skills/azure-typespec-author, .github/skills/azure-typespec-author and .opencode/skills/azure-typespec-author in your project.

What does Azure Typespec Author need to run?

Going by SKILL.md and its folder, Azure Typespec Author needs JavaScript for the scripts in its folder. Our summary lists: Node.js. Compatibility (from SKILL.md): azure-sdk-mcp server with azure-sdk-mcp:azsdk_typespec_retrieve_knowledge and azure-sdk-mcp:azsdk_run_typespec_validation tools.

Does Azure Typespec Author access the network?

SKILL.md contains no URLs. Any network use would come from the scripts or tools the agent runs. This is read from the text; nothing was executed.

Is Azure Typespec Author safe to install?

Our automated static check of SKILL.md found no risky patterns, such as piping downloads into a shell, reading credential files or hidden Unicode. It is not a guarantee. Review the folder before installing.

What licence does Azure Typespec Author use?

Azure Typespec Author is published under the MIT licence (declared in SKILL.md). It allows redistribution, so the full SKILL.md is shown on this page.

How many tokens does Azure Typespec Author use?

About 1.9k tokens (SKILL.md is roughly 7.8k characters). Agents keep only the skill's name and description in context until a task matches; then they load SKILL.md in full. Its references folder adds about 5.1k tokens, read only when the agent opens those files.

What are the alternatives to Azure Typespec Author?

Skills that share tags, products or a category with Azure Typespec Author: Azure Aigateway (microsoft/GitHub-Copilot-for-Azure, 255 stars), MCP Server Builder (alirezarezvani/claude-skills, 28k stars), Setup (fcakyon/claude-codex-settings, 1.2k stars) and MCP Server Builder (borghei/Claude-Skills, 886 stars). The comparison table on this page puts their stars, adoption, token cost, safety result and licence side by side.

Who maintains Azure Typespec Author?

Azure (a GitHub organization, an official publisher) maintains it in Azure/azure-sdk-tools, which has 134 GitHub stars. The repository holds 35 skills in this directory. The repository was last updated on October 9, 2026.

Source: Azure/azure-sdk-tools on GitHub. Facts on this page come from the repository at the commit we read; the author's words are quoted as theirs.