Add Env Setup to Copilot Instructions #53785
There are no files selected for viewing
| Original file line number | Diff line number | Diff line change |
|---|---|---|
|
|
@@ -3,6 +3,7 @@ | |
| This repo contains Azure SDKs for various Azure services and tools that generate them. | ||
|
|
||
| ## Prerequisites | ||
| - Always run the [`azsdk_verify_setup`](../eng/common/instructions/azsdk-tools/verify-setup.instructions.md) tool to check the user's development environment setup for using SDK MCP tools. DO NOT PROCEED with running other tools before completing this step. Only skip for queries that don't need tools. | ||
|
Member
There was a problem hiding this comment. I think you'll have to use an absolute link to pass the pipeline
Member
Author
There was a problem hiding this comment. The LLM seems to perform better with the relative link than if I linked to a web page, and I noticed some repos are currently using relative links 🤔 (example from rest-api-specs with check package readiness https://github.com/Azure/azure-rest-api-specs/blob/main/.github/copilot-instructions.md#release-readiness-of-sdk-and-information-about-the-release-pipeline )
Member
There was a problem hiding this comment. Ohh that's interesting, but that does make sense to me since copilot likes when things are available in the same workspace. It looks like the verify links is an eng/common check. I'm not totally sure where the requirement comes from, but maybe we could revisit
Member
There was a problem hiding this comment. @weshaggard for feedback on the link check. FYI the check is in place because our guidelines say that we should always use absolute paths
Member
There was a problem hiding this comment. Yes our link checker ensures links are absolute because most of them get published to docs sites outside of our repo. However for instructions @jeo02 found a workaround which is to use a link like
Member
Author
There was a problem hiding this comment. I tried this out, it looks like adding the #file has the same effect of using an absolute path where the LLM doesn't read it for me? (Copilot will say 1 reference used instead of 2 including the verify-setup-instructions) vs. 
Member
There was a problem hiding this comment. That is interesting. According to copilot chat it doesn't look at any links only open files.
Member
There was a problem hiding this comment. #file:path would only work if the file your trying to refer is in the same directory which is not the case here unfortunately. I believe in the copilot instructions in rest-api-specs we still use the relative path to refer to instructions under common/instructions. GitHub links are hit or miss as it is up to copilot to follow it in the moment whereas relative links will add the whole file referenced to the end of the copilot instructions. (You can see this in the Copilot Logs)
Member
There was a problem hiding this comment. Ok if we need to use relative links in these MD files we can either override the link checking or opt-out these instructions from link checking.
Member
There was a problem hiding this comment. I've got PR Azure/azure-sdk-tools#12863 which will disable these link guidelines for instruction files. For now, we can by-pass this check and merge this PR. |
||
| - To use MCP tool calls, PowerShell must be installed. Provide [PowerShell installation instructions](https://learn.microsoft.com/powershell/scripting/install/installing-powershell) if not installed, and recommend restarting the IDE to use the MCP server. | ||
|
|
||
| ## Folder Structure | ||
|
|
||
Uh oh!
There was an error while loading. Please reload this page.