Skip to content

docs: interop with AGENTS.md and Skills (markdown agent patterns)#86

Merged
sgriffiths merged 3 commits into
mainfrom
feat/markdown-interop
Jul 16, 2026
Merged

docs: interop with AGENTS.md and Skills (markdown agent patterns)#86
sgriffiths merged 3 commits into
mainfrom
feat/markdown-interop

Conversation

@sgriffiths

Copy link
Copy Markdown
Contributor

Docs and examples only — zero schema or runtime changes.

What this adds

  • docs/proposals/markdown-interop.md — position OA relative to AGENTS.md / SKILL.md, with the bright-line rule: markdown patterns may point at OA specs; OA specs never point at markdown patterns.
  • Root AGENTS.md — dogfoods the pattern: directs coding agents to define behaviour as OA specs and run them via the CLI, plus contributor dev/test commands.
  • examples/skill-wrapper/ — a SKILL.md that wraps a typed, validated OA spec (spec.yaml) instead of improvising summarisation, with a README explaining the division of labour.
  • README positioning section — "How OA Relates to AGENTS.md and Skills".

Follow-up fixes on this branch (commit 2999cde)

  • Corrected the conformance command in AGENTS.md — it referenced a non-existent module/flags; now uses the real entry point python -m spec.conformance.runner.conformance_runner, and the wording reflects that the runtime-agnostic cases run against the Python runtime.
  • Softened the matching README claim accordingly (no node adapter is wired into the suite yet).
  • Documented the OpenAI→Anthropic engine swap in the skill-wrapper example (spec.yaml comment, SKILL.md prerequisites, example README) to show the contract is engine-portable.

Notes for review

  • The skill-wrapper spec.yaml parses and matches the schema shape, but has not been run end-to-end (oa run) — worth confirming via CI or a manual run before merge.
  • Proposal is currently Status: Proposed while the README ships the positioning as settled — decide whether to flip it to Accepted or soften the README.

@sgriffiths
sgriffiths requested a review from aswhitehouse as a code owner July 5, 2026 00:41
@vercel

vercel Bot commented Jul 5, 2026

Copy link
Copy Markdown

The latest updates on your projects. Learn more about Vercel for GitHub.

Project Deployment Actions Updated (UTC)
open-agent-spec Ready Ready Preview, Comment Jul 12, 2026 5:42am

Request Review

@aswhitehouse aswhitehouse left a comment

Copy link
Copy Markdown
Collaborator

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Thanks for picking this branch up and for the engine-portability additions — the spec.yaml comment showing the OpenAI→Anthropic swap with everything else unchanged is a genuinely good improvement, since portability is exactly the property the example exists to demonstrate.

One important correction though: the "fix" in 2999cde is based on a stale branch view, not a real gap. See inline comments — this branch was cut from 37e3607 (pre-#82), so spec.conformance.harness.harness didn't exist on the branch when you checked. It has been on main since #82 merged (2026-07-03), together with the node adapter and the CI job running both runtimes. So the original command and the original README claim ("certified identical across runtimes") were correct against main — the branch just needs a rebase, after which 2999cde's downgrades should be reverted.

On your two review notes:

  • skill-wrapper e2e: correct that it hasn't had a live run — it passed oa validate but no keyed run yet. Agreed it should get one oa run before merge; it's the same shape as the proven file-reader spec minus the tool, so low risk.
  • Proposed vs settled: fair catch. Merging the README positioning is accepting the proposal, so flip the doc to Status: Accepted in the merge commit rather than softening the README.

Summary of requested changes: rebase on main → revert the AGENTS.md command and README claim from 2999cde (keep the engine-swap docs) → one live oa run of the example → flip proposal status to Accepted.

Comment thread AGENTS.md Outdated
Comment thread README.md Outdated
@aswhitehouse
aswhitehouse self-requested a review July 10, 2026 06:45

@aswhitehouse aswhitehouse left a comment

Copy link
Copy Markdown
Collaborator

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

LGTM

sgriffiths pushed a commit that referenced this pull request Jul 11, 2026
…p proposal

Reverts the two doc downgrades from 2999cde that were based on a
pre-#82 branch view. The conformance harness (spec.conformance.harness.harness)
and the node adapter have been on main since #82, and CI runs both runtimes,
so the original wording was correct against main:

- AGENTS.md: restore the both-runtime conformance command
  (harness.harness --adapter python --adapter node).
- README.md: restore "certified identical across runtimes".

The skill-wrapper engine-swap docs from 2999cde are kept.

Also flips the markdown-interop proposal to Status: Accepted, since
merging the README positioning accepts it.

Addresses review feedback from @aswhitehouse on #86.

Co-Authored-By: Claude Opus 4.8 <noreply@anthropic.com>
Claude-Session: https://claude.ai/code/session_01XdPprn1xTRiR1rGZf4jUfP
aswhitehouse and others added 2 commits July 11, 2026 22:45
Defines OA's relationship to the AGENTS.md / SKILL.md patterns without
attaching to them. One bright-line rule: markdown patterns may point at
OA specs; OA specs never point at markdown patterns.

- docs/proposals/markdown-interop.md: full proposal — background, risks
  (discoverability collision, distribution channel), position (guidance
  layer vs execution contract), what we refuse, how we manage it
- examples/skill-wrapper/: SKILL.md wrapping a typed OA spec — turns the
  skills ecosystem into a distribution channel for specs
- AGENTS.md: dogfoods the coexistence pattern — points coding agents at
  specs and the CLI instead of hand-rolled agent logic
- README: "How OA Relates to AGENTS.md and Skills" positioning section

Zero schema or runtime changes.

Co-authored-by: Cursor <cursoragent@cursor.com>
… swap

- AGENTS.md pointed at a non-existent module/flags
  (spec.conformance.harness.harness --adapter ...); replace with the real
  entry point (spec.conformance.runner.conformance_runner) and note the
  suite runs the runtime-agnostic cases against the Python runtime.
- Soften the matching README claim from 'certified identical across
  runtimes' to 'pinned to a shared, runtime-agnostic conformance suite'.
- skill-wrapper: document the OpenAI->Anthropic engine swap in spec.yaml,
  SKILL.md prerequisites, and the example README to demonstrate portability.
sgriffiths pushed a commit that referenced this pull request Jul 11, 2026
…p proposal

Reverts the two doc downgrades from 2999cde that were based on a
pre-#82 branch view. The conformance harness (spec.conformance.harness.harness)
and the node adapter have been on main since #82, and CI runs both runtimes,
so the original wording was correct against main:

- AGENTS.md: restore the both-runtime conformance command
  (harness.harness --adapter python --adapter node).
- README.md: restore "certified identical across runtimes".

The skill-wrapper engine-swap docs from 2999cde are kept.

Also flips the markdown-interop proposal to Status: Accepted, since
merging the README positioning accepts it.

Addresses review feedback from @aswhitehouse on #86.

Co-Authored-By: Claude Opus 4.8 <noreply@anthropic.com>
Claude-Session: https://claude.ai/code/session_01XdPprn1xTRiR1rGZf4jUfP
@sgriffiths
sgriffiths force-pushed the feat/markdown-interop branch from 61e8e30 to aa26a7f Compare July 11, 2026 22:45
…p proposal

Reverts the two doc downgrades from the previous commit, which were based on
a pre-#82 branch view. The conformance harness (spec.conformance.harness.harness)
and the node adapter have been on main since #82, and CI runs both runtimes,
so the original wording was correct against main:

- AGENTS.md: restore the both-runtime conformance command
  (harness.harness --adapter python --adapter node).
- README.md: restore "certified identical across runtimes".

The skill-wrapper engine-swap docs are kept.

Also flips the markdown-interop proposal to Status: Accepted, since merging
the README positioning accepts it.

Addresses review feedback from @aswhitehouse on #86.

@aswhitehouse aswhitehouse left a comment

Copy link
Copy Markdown
Collaborator

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

LGTM

@sgriffiths
sgriffiths merged commit 39e286d into main Jul 16, 2026
4 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.

3 participants