Skip to content

Commit e3e0072

Browse files
docs: fix documentation drift — engine defaults, Quick Start example, missing template marker and architecture entries (#314)
* Initial plan * docs: fix documentation drift — engine defaults, Quick Start example, missing marker and architecture entries Agent-Logs-Url: https://github.com/githubnext/ado-aw/sessions/eb011c3a-d2d2-425e-a15a-1843aaf1e21a 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 aacde87 commit e3e0072

2 files changed

Lines changed: 13 additions & 3 deletions

File tree

AGENTS.md

Lines changed: 9 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -32,7 +32,8 @@ Alongside the correctly generated pipeline yaml, an agent file is generated from
3232
│ │ ├── extensions/ # CompilerExtension trait and infrastructure extensions
3333
│ │ │ ├── mod.rs # Trait, Extension enum, collect_extensions(), re-exports
3434
│ │ │ ├── github.rs # Always-on GitHub MCP extension
35-
│ │ │ └── safe_outputs.rs # Always-on SafeOutputs MCP extension
35+
│ │ │ ├── safe_outputs.rs # Always-on SafeOutputs MCP extension
36+
│ │ │ └── tests.rs # Extension integration tests
3637
│ │ └── types.rs # Front matter grammar and types
3738
│ ├── init.rs # Repository initialization for AI-first authoring
3839
│ ├── execute.rs # Stage 3 safe output execution
@@ -43,6 +44,7 @@ Alongside the correctly generated pipeline yaml, an agent file is generated from
4344
│ ├── detect.rs # Agentic pipeline detection (helper for `configure`)
4445
│ ├── ndjson.rs # NDJSON parsing utilities
4546
│ ├── sanitize.rs # Input sanitization for safe outputs
47+
│ ├── validate.rs # Structural input validators (char allowlists, format checks, injection detectors)
4648
│ ├── agent_stats.rs # OTel-based agent statistics parsing (token usage, duration, turns)
4749
│ ├── safeoutputs/ # Safe-output MCP tool implementations (Stage 1 → NDJSON → Stage 3)
4850
│ │ ├── mod.rs
@@ -861,6 +863,12 @@ Environment variable names are validated against `[A-Za-z_][A-Za-z0-9_]*` to pre
861863

862864
If no passthrough env vars are needed, this marker is replaced with an empty string.
863865

866+
## {{ mcpg_step_env }}
867+
868+
Generates an `env:` block for the "Start MCP Gateway (MCPG)" pipeline step, forwarding pipeline variables required by enabled extensions (e.g., `AZURE_DEVOPS_EXT_PAT` when the Azure DevOps MCP tool is configured). The compiler iterates through all active `CompilerExtension` instances, collects their `required_pipeline_vars()` mappings, de-duplicates by variable name, and emits each as `VAR_NAME: $(VAR_NAME)` in ADO variable-reference syntax.
869+
870+
When no extensions require pipeline variables, this marker is replaced with an empty string and the MCPG step has no `env:` block.
871+
864872
## {{ mcp_client_config }}
865873

866874
**Removed.** The Copilot CLI `mcp-config.json` is no longer generated at compile time. Instead, it is derived at **pipeline runtime** from MCPG's actual gateway output, matching gh-aw's `convert_gateway_config_copilot.cjs` pattern.

README.md

Lines changed: 4 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -78,7 +78,9 @@ The AI will generate a markdown file like:
7878
---
7979
name: "Dependency Updater"
8080
description: "Checks for outdated dependencies and opens PRs"
81-
engine: claude-sonnet-4.5
81+
engine:
82+
id: copilot
83+
model: claude-sonnet-4.5
8284
schedule: weekly on monday around 9:00
8385
pool: AZS-1ES-L-MMS-ubuntu-22.04
8486
tools:
@@ -225,7 +227,7 @@ the service connections. Approve the permissions and the pipeline is ready.
225227
| `name` | string | **required** | Human-readable name for the agent |
226228
| `description` | string | **required** | One-line summary of the agent's purpose |
227229
| `target` | `standalone` \| `1es` | `standalone` | Pipeline output format |
228-
| `engine` | string or object | `claude-opus-4.5` | AI model to use |
230+
| `engine` | string or object | `copilot` | Engine identifier or object with `id`, `model`, `timeout-minutes`, etc. |
229231
| `schedule` | string or object | — | [Fuzzy schedule expression](#schedule-syntax) |
230232
| `pool` | string or object | `AZS-1ES-L-MMS-ubuntu-22.04` | Agent pool |
231233
| `workspace` | `root` \| `repo` | auto | Working directory mode |

0 commit comments

Comments
 (0)