Skip to content

Commit 2a0047d

Browse files
committed
Trying to be more lean in AGENTS.md
1 parent 16b448c commit 2a0047d

2 files changed

Lines changed: 15 additions & 36 deletions

File tree

.agents/CONVENTIONS.md

Lines changed: 12 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,12 @@
1+
# Notation conventions
2+
3+
Agent-facing material in this repo distinguishes three shapes so an agent never has to guess whether a token is a cmdlet parameter, an API field, or a transport-agnostic idea.
4+
5+
- **PowerShell** — backtick the literal as it appears in `Get-Help <Cmdlet> -Full`. Switches stand alone; valued parameters use a space before the value.
6+
- `` `-ExtendedLogging` `` (switch), `` `-TaskId <GUID>` `` (valued), `` `Connect-Safeguard -Browser` `` (cmdlet + switch).
7+
- **API / JSON** — backtick a PascalCase field as `Field: value`, mirroring the transfer-object shape SPP emits and accepts.
8+
- `` `ExtendedLogs: true` ``, `` `OperationType: CheckPassword` ``.
9+
- **Concept (transport-agnostic)** — plain English, no backticks. Use this in orchestration prose where the agent should not yet be biased toward PS or API.
10+
- "with extended logging enabled", "trigger the affected operation".
11+
12+
Rule of thumb: `AGENTS.md` speaks **concept**. The skills speak **PowerShell** (e.g., `safeguard-ps-operations`) or **API** with backticks. When a skill bridges them, it shows both forms side by side.

AGENTS.md

Lines changed: 3 additions & 36 deletions
Original file line numberDiff line numberDiff line change
@@ -79,16 +79,7 @@ If the agent finds itself drafting a third clarifying question before any tool h
7979

8080
## Notation: PowerShell vs API vs concept
8181

82-
Agent-facing material in this repo distinguishes three shapes so an agent never has to guess whether a token is a cmdlet parameter, an API field, or a transport-agnostic idea.
83-
84-
- **PowerShell** — backtick the literal as it appears in `Get-Help <Cmdlet> -Full`. Switches stand alone; valued parameters use a space before the value.
85-
- `` `-ExtendedLogging` `` (switch), `` `-TaskId <GUID>` `` (valued), `` `Connect-Safeguard -Browser` `` (cmdlet + switch).
86-
- **API / JSON** — backtick a PascalCase field as `Field: value`, mirroring the transfer-object shape SPP emits and accepts.
87-
- `` `ExtendedLogs: true` ``, `` `OperationType: CheckPassword` ``.
88-
- **Concept (transport-agnostic)** — plain English, no backticks. Use this in orchestration prose where the agent should not yet be biased toward PS or API.
89-
- "with extended logging enabled", "trigger the affected operation".
90-
91-
Rule of thumb: this `AGENTS.md` speaks **concept**. The skills speak **PowerShell** (e.g., `safeguard-ps-operations`) or **API** with backticks. When a skill bridges them, it shows both forms side by side.
82+
See [`.agents/CONVENTIONS.md`](.agents/CONVENTIONS.md). Short version: `AGENTS.md` speaks concept (plain English); skills speak PowerShell (backticked cmdlets/switches) or API (backticked PascalCase fields).
9283

9384
## Authentication and safety
9485

@@ -100,15 +91,7 @@ Rule of thumb: this `AGENTS.md` speaks **concept**. The skills speak **PowerShel
10091

10192
## Sample and template index
10293

103-
The agent-facing index of every sample and template lives at [`docs/agent-reference/samples-index.md`](docs/agent-reference/samples-index.md). It is generated by `tools/Build-SamplesIndex.ps1` and CI fails the build if the committed copy is stale.
104-
105-
Use the index to find a starting point by `(protocol, auth-scheme, operations)`. Telnet samples are excluded — telnet is out of scope for the agent skill system (see `agent-skills-plan.md` §2). The repo retains the telnet samples for human reference.
106-
107-
Other agent-reference material:
108-
109-
- [`docs/agent-reference/strategy-decision-tree.md`](docs/agent-reference/strategy-decision-tree.md) — backs the `strategy-selection` skill.
110-
- [`docs/agent-reference/failure-patterns.md`](docs/agent-reference/failure-patterns.md) — empty until Phase 5; grown from real extended task logs.
111-
- [`docs/agent-reference/vendor-doc-search-recipes.md`](docs/agent-reference/vendor-doc-search-recipes.md) — query templates and a paste-normalization recipe.
94+
The agent-facing index of every sample and template lives at [`docs/agent-reference/samples-index.md`](docs/agent-reference/samples-index.md) (generated by `tools/Build-SamplesIndex.ps1`; CI fails if stale). Use it to find a starting point by `(protocol, auth-scheme, operations)`. Telnet samples are excluded — telnet is out of scope for the agent skill system. Other agent-reference material lives alongside it in [`docs/agent-reference/`](docs/agent-reference/) (decision tree, failure-pattern catalog, vendor-doc search recipes).
11295

11396
## Workflow: new platform
11497

@@ -175,22 +158,6 @@ The five capability skills. Each `SKILL.md` opens with a pre-flight pointer back
175158
| `safeguard-ps-operations` | Driving a live SPP appliance through `safeguard-ps`: `Connect-Safeguard -Browser`, `Test-` / `Import-` / `Export-SafeguardCustomPlatformScript`, asset/account create-or-update, triggering operations with extended logging, fetching task-log JSON. Wraps [`tools/Invoke-PlatformDevLoop.ps1`](tools/Invoke-PlatformDevLoop.ps1). All cmdlet syntax must come from `Get-Help <Cmdlet> -Full`. | `full-loop` (most operations); `author-only` for `Test-` and `Export-` against a local file | [`.agents/skills/safeguard-ps-operations/SKILL.md`](.agents/skills/safeguard-ps-operations/SKILL.md) |
176159
| `task-log-analysis` | An operation has run and produced an extended task log that must be classified (`connect` / `auth` / `parse` / `operation` / `unknown`) and turned into a next step. Backed by [`docs/agent-reference/failure-patterns.md`](docs/agent-reference/failure-patterns.md), which ships empty and grows only from real runs. | `full-loop` (live log); `author-only` (saved JSON file) | [`.agents/skills/task-log-analysis/SKILL.md`](.agents/skills/task-log-analysis/SKILL.md) |
177160

178-
### Family-consistency note
179-
180-
The structure here matches the safeguard-ps `AGENTS.md` precedent (overview → project structure → conventions → on-demand skills routing table → "Keeping this file current"). Two intentional deviations:
181-
182-
- **Workflows live in this file** rather than as separate skills. They are orchestration, which is what `AGENTS.md` is for; promoting them to skills would create load-order ambiguity with the routing table. (See `agent-skills-plan.md` §4–§5.)
183-
- **The routing table includes a `Modes` column.** This repo has explicit `author-only` / `probe-only` / `full-loop` modes; safeguard-ps does not. Surfacing modes in the table prevents an agent from loading a skill in a mode where it fails closed.
184-
185161
## Keeping this file current
186162

187-
Update this file when any of the following change:
188-
189-
- A skill is added, renamed, retired, or its supported modes change → update the routing table and any workflow step that references it.
190-
- A workflow step is added, removed, or reordered → update both `Workflow: new platform` and `Workflow: enhance platform` so they stay aligned.
191-
- The iterative debug-loop budget changes → update both the loop section and any skill that restates the budget in its pre-flight (currently `task-log-analysis`).
192-
- Files in `docs/agent-reference/` are added or moved → update the pointers in `Sample and template index` and the routing table.
193-
- The safeguard-ps `AGENTS.md` precedent diverges from this file in a way we want to track → update the family-consistency note above with the reason.
194-
- A new section is added that describes cmdlet parameters, API fields, or transport-agnostic concepts → follow the conventions in **Notation: PowerShell vs API vs concept**. Skills authored or revised after this file changes should adopt the same convention so PS / API / concept stay visually distinct across the corpus.
195-
196-
Propose updates as part of the same change that introduces the underlying drift; do not let routing entries and skill files drift out of sync.
163+
When skills, workflows, modes, the loop budget, or `docs/agent-reference/` paths change, update this file in the same change. Do not let the routing table drift from the skills it points at.

0 commit comments

Comments
 (0)