azure-sdk-for-rust AGENTS.md

AGENTS.md

This document provides guidance for AI agents (e.g., GitHub Copilot, MCP servers, or LLM-based assistants) interacting with the Azure SDK for Rust repository.

Repository Overview

The Azure SDK for Rust provides Rust language bindings and client libraries for Azure services, following the Azure SDK Design Guidelines for Rust.

• Primary Language: Rust
• Minimum Supported Rust Version (MSRV): found in the root Cargo.toml file
• Key Technologies: Cargo, TypeSpec, OpenTelemetry, Test Proxy

Repository Structure

.
├── sdk/                      # Service-specific crates organized by service
│   └── {service}/            # Service directory (e.g., "keyvault", "storage")
│       ├── {crate}/          # Service crate (e.g., "azure_security_keyvault_secrets")
│       ├── assets.json       # Pointer to test recordings (may be under {crate}/)
│       ├── test-resources.bicep # Test resource definitions (may be under {crate}/)
│       └── tsp-location.yaml # Pointer to TypeSpec in azure-rest-api-specs (may be under {crate}/)
├── eng/                      # Engineering system scripts and common tooling
├── doc/                      # Additional documentation
├── .github/
│   ├── instructions/         # Agent instruction files for specific tasks
│   └── skills/               # Copilot skills (e.g., check-spelling, lint-markdown)
├── CONTRIBUTING.md           # Contribution guidelines (see for detailed workflows)
└── README.md                 # Repository overview

Agent Capabilities

Always check if there is an MCP tool or skill available before performing operations manually, including listing Azure subscriptions, deploying resources, setting up a new crate, generating code, and other common workflows.

All new crates must be generated from TypeSpec specifications in [Azure/azure-rest-api-specs]. TypeSpec specifications are located under specification/{service}/. Use the create-crate skill to set up a new crate.