Skip to content

docs: scrub README + add AGENTS.md#58

Merged
manojp99 merged 2 commits into
mainfrom
docs/readme-scrub-and-agents-md
Jun 15, 2026
Merged

docs: scrub README + add AGENTS.md#58
manojp99 merged 2 commits into
mainfrom
docs/readme-scrub-and-agents-md

Conversation

@manojp99

Copy link
Copy Markdown
Collaborator

Summary

This docs-only PR addresses two longstanding gaps:

  1. README scrubbed of accumulated drift — verified against the live engine through comprehensive CLI probe battery
  2. New AGENTS.md added — establishes canonical per-repo contributor conventions per foundation guidance

No code changes, no behavior changes, no version bumps.

Verification

Changes verified against live DTU instance aaa-readme-scrub (now destroyed) using uv tool install . from local source with full probe battery against Anthropic API:

  • --help flag
  • run --help flag
  • doctor command
  • config show command
  • Live turns against Anthropic API
  • Protocol compatibility
  • Flag conflict rejection
  • Embedding example imports
  • Python wrapper SDK examples

README Drift Corrections

Area Was Now
Engine version 0.3.0 0.6.0 (PR #55)
Wire protocol 0.2.0 0.3.0 (PR #56)
TS wrapper version 0.4.0 0.7.0 (PR #55)
Python wrapper amplifier_agent_client in wrappers/python/ amplifier-agent-py@0.3.0 in wrappers/python-py/ (PR #56)
Storage paths $XDG_CACHE_HOME / $XDG_STATE_HOME $AMPLIFIER_AGENT_HOME (defaults to ~/.amplifier-agent/) — design 2026-06-11-drop-xdg-and-flag-cleanup.md
--output default json text (PR #51)
Quick start examples bare run "prompt" run -y "prompt" — headless runs now require explicit -y/-n/approval.mode; no more silent auto-deny
Admin commands missing migrate, models, update, version now included; migrate is user-invoked (PR #52)
run flag table listed dropped flags --mcp-config-path, --host-capabilities drops both; adds --display, --cwd, --workspace, --config
Embedding example imports valid but approval mode was "no" updated to "yes" to reflect mandatory approval policy
Mode A / Mode B framing "Modes" table, "Wire protocol (Mode A)" header, explicit Mode B mention all removed per maintainer direction — there is only one mode now

AGENTS.md

Brand new file (~175 lines) establishing canonical contributor conventions:

  • Repository structure and directory purposes
  • Build, lint, and test commands (uv run, bun run, pnpm test)
  • Cross-component invariants (6 constraints on protocol bumps, wrapper coordination, etc.)
  • Design-doc-driven development convention (docs/designs/YYYY-MM-DD-slug.md)
  • Conventional commit scopes observed in recent history
  • Common pitfalls and definition of done checklist

References

Related design documents and PRs:

Manoj Prabhakar Paidiparthy and others added 2 commits June 15, 2026 00:24
…raming

Verified changes against live DTU instance aaa-readme-scrub using
`uv tool install .` from local source with full CLI probe battery
against Anthropic API.

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

Co-Authored-By: Amplifier <240397093+microsoft-amplifier@users.noreply.github.com>
Establishes canonical file where contributors and AI agents discover:
- Repository structure and directory purposes
- Build, lint, and test commands
- Cross-component invariants and constraints
- Design-doc-driven development convention
- Conventional commit scopes observed in this repo
- Common pitfalls and definition of done

No changes to code, behavior, or version numbers.

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

Co-Authored-By: Amplifier <240397093+microsoft-amplifier@users.noreply.github.com>
@manojp99 manojp99 merged commit f7ad76e into main Jun 15, 2026
2 of 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