Create Crate
Developmentcreate-crateCreate 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.
QUICK START
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.
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.
-
Install tsp-client
- Follow
eng/common/tsp-client/README.mdto install dependencies - Run
npm cifromeng/common/tsp-client/ - Use
npm exec --prefix eng/common/tsp-client -- tsp-client {command}to invoke it from the repository root
- Follow
-
Find the TypeSpec spec
- Look for a
tspconfig.yamlunderspecification/{service}/in azure-rest-api-specs - Check the
tspconfig.yamlfor@azure-tools/typespec-rustemitter 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
- Look for a
-
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 thetspconfig.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
- Run
-
Generate the client
- Use the
azsdk_package_generate_codeMCP tool, or - Run
npm exec --prefix eng/common/tsp-client -- tsp-client updatefrom the crate directory
- Use the
-
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/
- Create
-
Register the crate
- Add the new crate to the workspace
memberslist in the rootCargo.toml
- Add the new crate to the workspace
-
Add tests, examples, and documentation
- Write unit tests and integration tests (using
#[recorded::test]) - Add examples, a
README.md, and aCHANGELOG.md
- Write unit tests and integration tests (using