From 25aa0127f17ff1ec243451f884d6bae7d09d62ba Mon Sep 17 00:00:00 2001 From: sadlilas <11658960+sadlilas@users.noreply.github.com> Date: Sun, 16 Aug 2026 14:13:41 -0700 Subject: [PATCH] docs(skill): use absolute URLs for the three inline doc references MIME-Version: 1.0 Content-Type: text/plain; charset=UTF-8 Content-Transfer-Encoding: 8bit The amplifier-agent skill is being prepared for public distribution. When installed independently from a repository checkout, relative paths in the skill body become unresolvable. Three inline prose references used bare repo-relative paths: - line 97: wrappers/typescript/README.md - line 129: docs/spec/engine-api.md (critical — the skill instructs agents to READ this file before using the in-process library) - line 183: docs/spec/envelope-and-errors.md Line 129 is the serious case: an agent told to read a file it cannot open will either stall or guess. This skill was written explicitly to prevent guessing. Convert all three from bare backtick paths to markdown links pointing at https://github.com/microsoft/amplifier-agent/blob/main/, keeping the filename visible in link text for readability. Validated against official Agent Skills spec: - npx skills-ref validate ./skills/amplifier-agent → 'Valid skill' (exit 0) - All 9 GitHub URLs resolve on main - No bare repo-relative paths remain in prose - Still within spec limits: 208 lines (<500), ~3,398 tokens (<5,000) 🤖 Generated with [Amplifier](https://github.com/microsoft/amplifier) Co-Authored-By: Amplifier <240397093+microsoft-amplifier@users.noreply.github.com> --- skills/amplifier-agent/SKILL.md | 6 +++--- 1 file changed, 3 insertions(+), 3 deletions(-) diff --git a/skills/amplifier-agent/SKILL.md b/skills/amplifier-agent/SKILL.md index ee36ad3d..fd2fc998 100644 --- a/skills/amplifier-agent/SKILL.md +++ b/skills/amplifier-agent/SKILL.md @@ -94,7 +94,7 @@ for await (const event of session.submit('Hello, agent.')) { `spawnAgent` options: `lifecycle` (must be `'one-shot'`), `sessionId`, `resume`, `workspace`, `cwd`, `approval` (`{ mode: 'yes' | 'no' | 'prompt' }`), `configPath`, `env` (`{ allowlist, extra }`), `mcpServers`, `displayMode`, `display`, `timeoutMs`, `allowProtocolSkew`. Type definitions ship at `node_modules/amplifier-agent-ts/dist/index.d.ts`; read them rather than recalling the shape. -> The `submit()` example in `wrappers/typescript/README.md` is stale (it awaits a `{ reply }` object). Follow the iterable form above, which matches the shipped types. +> The `submit()` example in [`wrappers/typescript/README.md`](https://github.com/microsoft/amplifier-agent/blob/main/wrappers/typescript/README.md) is stale (it awaits a `{ reply }` object). Follow the iterable form above, which matches the shipped types. ## Python SDK @@ -126,7 +126,7 @@ with spawn_agent_sync( ## In-process library -`amplifier_agent_lib` is transport-free Python, and the CLI binary is a thin I/O adapter over it, so both paths share all engine behavior. You give up process isolation. The public contract is the `Engine` class: `boot()`, then `submit_turn()` per turn, then `shutdown()`. Read `docs/spec/engine-api.md` before using it; it is the normative contract and names every public symbol. +`amplifier_agent_lib` is transport-free Python, and the CLI binary is a thin I/O adapter over it, so both paths share all engine behavior. You give up process isolation. The public contract is the `Engine` class: `boot()`, then `submit_turn()` per turn, then `shutdown()`. Read [`docs/spec/engine-api.md`](https://github.com/microsoft/amplifier-agent/blob/main/docs/spec/engine-api.md) before using it; it is the normative contract and names every public symbol. ## HTTP face @@ -180,7 +180,7 @@ A per-instance config file looks like this: ## Error codes at the integration seams -`docs/spec/envelope-and-errors.md` is the full registry, wire codes plus CLI-only codes. These are the ones raised at the seams a host owns: binary discovery, argv and config validation, the protocol handshake, approval, and session resume. The rest fire inside a turn. +[`docs/spec/envelope-and-errors.md`](https://github.com/microsoft/amplifier-agent/blob/main/docs/spec/envelope-and-errors.md) is the full registry, wire codes plus CLI-only codes. These are the ones raised at the seams a host owns: binary discovery, argv and config validation, the protocol handshake, approval, and session resume. The rest fire inside a turn. | Code | Raised when | What to do | |---|---|---|