OpenParable
Skip to content
← Back to skills

Create Crate

Development
create-crate

Create Crate is an Agent Skill for development published in the Azure/azure-sdk-for-rust repository on GitHub: a SKILL.md instruction file an AI agent can load to do this task.

Create a new Azure SDK crate from a TypeSpec specification.

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/Azure/azure-sdk-for-rust/blob/HEAD/.github/skills/create-crate/SKILL.md and all supporting files. Report provenance, permissions, scripts, dependencies, and security risks. Propose an exact installation into .agents/skills/create-crate, 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.

Creating a New Crate

All new service crates must be generated from TypeSpec specifications in Azure/azure-rest-api-specs. Do not hand-write client libraries from scratch.

  1. Install tsp-client

    • Follow eng/common/tsp-client/README.md to install dependencies
    • Run npm ci from eng/common/tsp-client/
    • Use npm exec --prefix eng/common/tsp-client -- tsp-client {command} to invoke it from the repository root
  2. Find the TypeSpec spec

    • Look for a tspconfig.yaml under specification/{service}/ in azure-rest-api-specs
    • Check the tspconfig.yaml for @azure-tools/typespec-rust emitter configuration
    • If no emitter configuration exists, stop and report an error indicating that the TypeSpec specification in Azure/azure-rest-api-specs must be updated before generating the client
  3. Initialize the crate

    • Run npm exec --prefix eng/common/tsp-client -- tsp-client init --tsp-config {url} from the repository root
    • {url} is the GitHub URL to the tspconfig.yaml
    • Always use a specific commit SHA in the URL — never a branch or tag, which can move
    • Example: https://github.com/Azure/azure-rest-api-specs/blob/{commit-sha}/specification/{service}/{rp}/tspconfig.yaml
  4. Generate the client

    • Use the azsdk_package_generate_code MCP tool, or
    • Run npm exec --prefix eng/common/tsp-client -- tsp-client update from the crate directory
  5. Add hand-written wrappers

    • Create clients.rs (or similar) for custom client constructors, authentication setup, and convenience methods
    • Build on top of the generated code in src/generated/
  6. Register the crate

    • Add the new crate to the workspace members list in the root Cargo.toml
  7. Add tests, examples, and documentation

    • Write unit tests and integration tests (using #[recorded::test])
    • Add examples, a README.md, and a CHANGELOG.md