docs: make the README and integration guide agent-facing - #118
Merged
David Koleczek (DavidKoleczek) merged 1 commit intoAug 11, 2026
Merged
Conversation
Users pasting the adoption snippet into a coding agent were getting pushback: the agent either questioned whether amplifier-agent was the right dependency, or redirected them to the wider Amplifier ecosystem. README: - Point the paste snippet at docs/INTEGRATION.md so an agent has a deterministic destination written for integrators, rather than a repo root whose lead is oriented to a human at a terminal. - Replace "What it is" and "Why" with a definition and a capability list. The per-turn subprocess mechanics were contract detail, not orientation, and are covered in the integration guide. - State that the engine is standalone in "Architecture at a glance". docs/INTEGRATION.md: - Add "Before you start": the engine is standalone, no other microsoft/amplifier* repository substitutes for it, and it suits both agent loops and plain LLM calls via provider routing. Capability claims were verified against the shipped bundle. Dropped recipes (no recipe content ships) and apply-patch (provider-specific default engine, opaque to a README reader). Corrected provider selection to credentials-from-environment, since env-based provider detection is no longer performed on the run path. 🤖 Generated with [Amplifier](https://github.com/microsoft/amplifier) Co-Authored-By: Amplifier <240397093+microsoft-amplifier@users.noreply.github.com>
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.This suggestion is invalid because no changes were made to the code.Suggestions cannot be applied while the pull request is closed.Suggestions cannot be applied while viewing a subset of changes.Only one suggestion per line can be applied in a batch.Add this suggestion to a batch that can be applied as a single commit.Applying suggestions on deleted lines is not supported.You must change the existing code in this line in order to create a valid suggestion.Outdated suggestions cannot be applied.This suggestion has been applied or marked resolved.Suggestions cannot be applied from pending reviews.Suggestions cannot be applied on multi-line comments.Suggestions cannot be applied while the pull request is queued to merge.Suggestion cannot be applied right now. Please check back later.
Why
Changes
README
docs/INTEGRATION.md.What it isandWhyare replaced by a definition plus a capability list. The per-turn subprocess mechanics were contract detail rather than orientation, and are already covered in the integration guide.Architecture at a glancestates that the engine is standalone.docs/INTEGRATION.md
Before you startsection: the engine is standalone, no othermicrosoft/amplifier*repository substitutes for it, and it suits both agent loops and plain LLM calls via provider routing.Accuracy
Capability claims were checked against the shipped bundle rather than carried over:
tool-recipesis mounted, but no recipe content ships and only#subdirectory=modules/tool-recipesis pulled in, so the upstream examples do not resolve for a user.tool-apply-patchdefaults to thenativeengine, which is a host-side handler for the OpenAI Responses-API built-in tool. Provider-specific, and opaque to a README reader.runpath; resolution is host config, thendefault_provider.Follow-ups (not in this PR)
README.mdquick start anddocs/CONFIGURATION.mdboth document an auto-detection order that therunpath no longer performs, and both omitgithub-copilot.bundle.mdsetsvisibility.enabled: falsefortool-skillswhile the adjacent comment claims visibility is enabled.