From a35622ff0250a8f93951df6a8d2052b5ef7aad40 Mon Sep 17 00:00:00 2001 From: "FAREAST\\chunyu" Date: Mon, 1 Dec 2025 10:42:04 +0800 Subject: [PATCH] add a more tool parameters --- .../typespec-authoring.instructions.md | 41 +++++++++++++++++++ 1 file changed, 41 insertions(+) create mode 100644 eng/common/instructions/azsdk-tools/typespec-authoring.instructions.md diff --git a/eng/common/instructions/azsdk-tools/typespec-authoring.instructions.md b/eng/common/instructions/azsdk-tools/typespec-authoring.instructions.md new file mode 100644 index 000000000..26fe7edc5 --- /dev/null +++ b/eng/common/instructions/azsdk-tools/typespec-authoring.instructions.md @@ -0,0 +1,41 @@ +--- +description: "Guide the user to define and update TypeSpec based API spec" +--- + +# Goal + +Help the user define or update TypeSpec API specifications using the `azure-sdk-mcp` tools. + +## 🧩 Context +This instruction applies to all tasks involving **TypeSpec**, including: +- Writing new TypeSpec definitions +- Editing or refactoring existing TypeSpec files +- Resolving TypeSpec-related issues + +## ⚙️ Workflow Guidance + +When encountering a TypeSpec-related task, follow this process: + +1. **Call the `azsdk-qa-bot` tool** + Use this tool to retrieve validated solutions, suggestions, or fixes for TypeSpec issues. + +2. **Extract the solution from the tool result** + Parse the response from `azsdk-qa-bot` to identify the recommended fix or implementation. + +3. **Execute the solution** + Apply the extracted solution to update the TypeSpec file accordingly. + +## 📁 Scope + +applyTo: "**/*.tsp" + +## Example Use Case + +## ✅ Best Practices +- Always prefer using \`azsdk-qa-bot\` before attempting manual fixes. +- Ensure the applied solution aligns with project standards and passes validation. +- Document any changes made based on bot recommendations in commit messages or PR descriptions. + +## 🚫 Avoid +- Making speculative changes to TypeSpec without consulting \`azsdk-qa-bot\`. +- Skipping the extraction step—always verify the solution before applying.