OpenParable
Skip to content
← Back to skills

Typespec SDK Generator

Development
typespec-sdk-generator

Typespec SDK Generator is an Agent Skill for development published in the a5c-ai/babysitter repository on GitHub: a SKILL.md instruction file an AI agent can load to do this task.

Microsoft TypeSpec-based API and SDK generation

View on GitHub ↗
QUICK START

How to use this skill

Bring this guide into your coding agent with a prompt tailored to the tool you use.

  1. Open your project in Codex.
  2. Copy and paste the prompt below.
  3. Review files and risks before approving any action.
Prompt to paste
Inspect the Agent Skill at https://github.com/a5c-ai/babysitter/blob/HEAD/library/specializations/sdk-platform-development/skills/typespec-sdk-generator/SKILL.md and all supporting files. Report provenance, permissions, scripts, dependencies, and security risks. Propose an exact installation into .agents/skills/typespec-sdk-generator, 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.

TypeSpec SDK Generator Skill

Overview

This skill utilizes Microsoft TypeSpec (formerly Cadl) to design APIs and generate multi-language SDKs following Azure SDK guidelines. TypeSpec provides a concise, type-safe language for API definition.

Capabilities

  • Design APIs using TypeSpec language
  • Generate multi-language SDKs (TypeScript, Python, Java, C#, Go)
  • Emit OpenAPI and other specification formats
  • Apply Azure SDK style guidelines automatically
  • Implement decorators for rich API semantics
  • Support versioning and deprecation patterns
  • Generate strongly-typed clients

Target Processes

  • SDK Code Generation Pipeline
  • API Design Specification
  • Multi-Language SDK Strategy

Integration Points

  • TypeSpec compiler and emitters
  • AutoRest for SDK generation
  • Azure SDK code generation pipeline
  • OpenAPI emitters
  • Custom emitter development

Input Requirements

  • TypeSpec model files (.tsp)
  • Emitter configurations per target
  • Versioning requirements
  • Style guide preferences
  • Custom decorators (if any)

Output Artifacts

  • Generated SDK source code per language
  • OpenAPI specifications
  • JSON schemas
  • API documentation
  • Client library packages

Usage Example

skill:
  name: typespec-sdk-generator
  context:
    modelDirectory: ./typespec
    emitters:
      - "@azure-tools/typespec-ts"
      - "@azure-tools/typespec-python"
      - "@typespec/openapi3"
    applyAzureGuidelines: true
    apiVersion: "2024-01-01"

Best Practices

  1. Use namespaces to organize API structure
  2. Leverage decorators for documentation and behavior
  3. Implement proper versioning with @versioned
  4. Use templates for reusable patterns
  5. Define clear model inheritance hierarchies
  6. Apply Azure SDK guidelines for consistency