Skip to content

docs: add an installable agent skill for integrating the engine - #121

Merged
David Koleczek (DavidKoleczek) merged 1 commit into
mainfrom
docs/agent-skill
Aug 14, 2026
Merged

docs: add an installable agent skill for integrating the engine#121
David Koleczek (DavidKoleczek) merged 1 commit into
mainfrom
docs/agent-skill

Conversation

@DavidKoleczek

Copy link
Copy Markdown
Collaborator

Adds skills/amplifier-agent/SKILL.md, an Agent Skills skill that teaches a coding agent how to install amplifier-agent and integrate it, so a user can point their agent at the engine without first reading the guides themselves.

What the skill covers

  • Installing the engine, including what to do when uv is missing, pinning a release, and the same-user rule for hosts that spawn a subprocess
  • Choosing among the five surfaces: TypeScript SDK, Python SDK, in-process library, HTTP face, and the CLI contract
  • A minimal working example per SDK, matching the shipped types
  • The constraints that break a host integration: approval policy, workspace scoping, protocol pinning, stream separation, and the closed host-config schema
  • The error codes raised at the seams a host owns, with the exit-code mapping

The body routes to docs/ for anything normative rather than restating it, so the guides stay the single source of truth.

Install

npx skills add microsoft/amplifier-agent

Works with GitHub Copilot, Claude Code, Codex, Cursor, and other clients that follow the skills.sh convention. The README also documents installing it by hand.

Scope of impact

Documentation only. No engine, wrapper, or spec changes.

The skill sits at the repo root, which is a well-known discovery path for the skills.sh CLI and is part of neither the wheel (packages is scoped to src/) nor the engine's built-in bundle. It ships to other agents, not to amplifier-agent itself.

Publishes `skills/amplifier-agent/SKILL.md`, an Agent Skills spec skill that
teaches a coding agent how to install amplifier-agent and integrate it from
TypeScript, Python, HTTP, or the CLI contract.

The body routes to the canonical docs rather than restating them. It covers
the surface picker, a minimal working example per SDK, the constraints that
break a host integration (approval policy, workspace scoping, protocol
pinning, stream separation), and the error codes raised at the seams a host
owns.

It installs with `npx skills add microsoft/amplifier-agent` for GitHub
Copilot, Claude Code, Codex, Cursor, and other clients following the skills.sh
convention. The skill lives at the repo root and is part of neither the wheel
nor the engine's built-in bundle, so it ships to other agents rather than to
amplifier-agent itself.

🤖 Generated with [Amplifier](https://github.com/microsoft/amplifier)

Co-Authored-By: Amplifier <240397093+microsoft-amplifier@users.noreply.github.com>
@DavidKoleczek
David Koleczek (DavidKoleczek) merged commit 50f1b68 into main Aug 14, 2026
3 checks passed
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

1 participant