Skip to content

Commit 34fc26d

Browse files
docs: fix documentation drift — add {{ copilot_version }}, remove phantom {{ workspace }}, document service-connection field (#54)
* Initial plan * docs: fix documentation drift for copilot_version, workspace, and service_connection Co-authored-by: jamesadevine <4742697+jamesadevine@users.noreply.github.com> --------- Co-authored-by: copilot-swe-agent[bot] <198982749+Copilot@users.noreply.github.com> Co-authored-by: jamesadevine <4742697+jamesadevine@users.noreply.github.com>
1 parent 31164d7 commit 34fc26d

1 file changed

Lines changed: 11 additions & 5 deletions

File tree

AGENTS.md

Lines changed: 11 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -479,7 +479,7 @@ Used by the execute command's --source parameter.
479479

480480
## {{ pipeline_path }}
481481

482-
Should be replaced with the path to the compiled pipeline YAML file for runtime integrity checking. The path is derived from the output path's filename and uses `{{ workspace }}` as the base (which gets resolved before this placeholder):
482+
Should be replaced with the path to the compiled pipeline YAML file for runtime integrity checking. The path is derived from the output path's filename and uses `{{ working_directory }}` as the base (which gets resolved before this placeholder):
483483
- `root`: `$(Build.SourcesDirectory)/<filename>.yml`
484484
- `repo`: `$(Build.SourcesDirectory)/$(Build.Repository.Name)/<filename>.yml`
485485

@@ -560,10 +560,6 @@ The threat analysis prompt instructs the security analysis agent to check for:
560560
- Secret leaks
561561
- Malicious patches (suspicious web calls, backdoors, encoded strings, suspicious dependencies)
562562

563-
## {{ workspace }}
564-
565-
An alias for `{{ working_directory }}`. Both markers are replaced with the same value based on the effective workspace setting.
566-
567563
## {{ agent_description }}
568564

569565
Should be replaced with the description field from the front matter. This is used in display contexts and the threat analysis prompt template.
@@ -624,6 +620,15 @@ https://github.com/github/gh-aw-firewall/releases/download/v{VERSION}/awf-linux-
624620

625621
A `checksums.txt` file is also downloaded and verified via `sha256sum -c checksums.txt --ignore-missing` to ensure binary integrity.
626622

623+
## {{ copilot_version }}
624+
625+
Should be replaced with the pinned version of the `Microsoft.Copilot.CLI.linux-x64` NuGet package (defined as `COPILOT_CLI_VERSION` constant in `src/compile/common.rs`). This version is used in the pipeline step that installs the Copilot CLI tool from Azure Artifacts.
626+
627+
The generated pipelines install the package from:
628+
```
629+
https://pkgs.dev.azure.com/msazuresphere/_packaging/Guardian1ESPTUpstreamOrgFeed/nuget/v3/index.json
630+
```
631+
627632
### 1ES-Specific Template Markers
628633

629634
The following markers are specific to the 1ES target (`target: 1es`) and are not used in standalone pipelines:
@@ -946,6 +951,7 @@ mcp-servers:
946951
**For built-in MCPs:**
947952
- `true` - Enable with all default functions
948953
- `allowed:` - Array of function names to restrict available tools
954+
- `service-connection:` - (1ES target only) Override the service connection name used for this MCP. If not specified, defaults to `mcp-<name>-service-connection` (e.g., `mcp-ado-service-connection` for the `ado` MCP)
949955

950956
**For custom MCPs (requires `command:`):**
951957
- `command:` - The executable to run (e.g., `"node"`, `"python"`, `"dotnet"`)

0 commit comments

Comments
 (0)