Skip to content

docs: refactor AGENTS.md into a dual-persona playbook - #644

Open
damaz91 wants to merge 4 commits into
Universal-Commerce-Protocol:mainfrom
damaz91:docs/refactor-agents-playbook
Open

docs: refactor AGENTS.md into a dual-persona playbook#644
damaz91 wants to merge 4 commits into
Universal-Commerce-Protocol:mainfrom
damaz91:docs/refactor-agents-playbook

Conversation

@damaz91

@damaz91 damaz91 commented Jul 28, 2026

Copy link
Copy Markdown
Contributor

Description

Refactored AGENTS.md to cleanly separate instructions for repository contributors (Persona B) and external implementers (Persona A).

  • Grouped reference sections for Checkout and Order capabilities to combine their REST and MCP transport specifications.
  • Added ucp-schema resolve and validate helper commands under local command reference.
  • Restored instructions advising AI agents on when to fetch external resource indices (like llms.txt).
  • Updated Python and JavaScript/TypeScript SDK sections to list PyPI and npm package URLs alongside GitHub repositories and installation commands.
  • Removed legacy SDK model generation references from contributor commands.

Category (Required)

  • Core Protocol: Changes to the base communication layer, global context, or breaking refactors. (Requires Technical Council approval)
  • Governance/Contributing: Updates to GOVERNANCE.md, CONTRIBUTING.md, or CODEOWNERS. (Requires Governance Council approval)
  • Capability: New schemas (Discovery, Cart, etc.) or extensions. (Requires Maintainer approval)
  • Documentation: Updates to README, or documentations regarding schema or capabilities. (Requires Maintainer approval)
  • Infrastructure: CI/CD, Linters, or build scripts. (Requires DevOps Maintainer approval)
  • Maintenance: Version bumps, lockfile updates, or minor bug fixes. (Requires DevOps Maintainer approval)
  • SDK: Language-specific SDK updates and releases. (Requires DevOps Maintainer approval)
  • Samples / Conformance: Maintaining samples and the conformance suite. (Requires Maintainer approval)
  • UCP Schema: Changes to the ucp-schema tool (resolver, linter, validator). (Requires Maintainer approval)
  • Community Health (.github): Updates to templates, workflows, or org-level configs. (Requires DevOps Maintainer approval)

Related Issues

None.

Checklist

  • I have followed the Contributing Guide (including Conventional Commits title requirements and ! for breaking changes).
  • I have updated the documentation (if applicable).
  • My changes pass all local linting and formatting checks.
  • I have added tests that prove my fix is effective or that my feature works.
  • New and existing unit tests pass locally with my changes.
  • (For Core/Capability) I have included/updated the relevant JSON schemas.
  • I have regenerated Python Pydantic models by running generate_models.sh under python_sdk.

Screenshots / Logs (if applicable)

None.

Refactor the AGENTS.md playbook to support both repository contributors and external implementers. Group specification links by capability (REST & MCP) and add local ucp-schema resolution and validation commands.

TAG=agy

CONV=72c98362-1fc7-4ed8-82b9-35b6e061a9fe
Comment thread AGENTS.md Outdated
Comment thread AGENTS.md Outdated
Remove duplicative specification links and clarify when to use versioned vs latest llms.txt indexes.

TAG=agy

CONV=ec0e386e-2b46-4505-bdfd-ff46cc45f79c
Comment thread AGENTS.md Outdated
Comment thread AGENTS.md Outdated
Split AGENTS.md into AGENT_CONTRIBUTOR.md and AGENT_IMPLEMENTER.md. AGENTS.md now acts as a router directing agents to the appropriate file. Ensure terminology 'merchant' and 'shopping' are avoided.

TAG=agy

CONV=d1d1e370-21bd-405a-bce2-c310c3866166
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Projects

None yet

Development

Successfully merging this pull request may close these issues.

3 participants