Skip to content

docs(readme): state that this is one adapter, not the way to consume workspace.json #14

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
qmarcelle merged 2 commits into from
Aug 13, 2026
Merged

docs(readme): state that this is one adapter, not the way to consume workspace.json #14

Changes from all commits
Commits
Show all changes
2 commits
Select commit Hold shift + click to select a range
3aa4531
docs(readme): state that this is one adapter, not the way to consume …
qmarcelle Aug 13, 2026
be2e965
Merge branch 'main' into gtm-39-host-neutral-framing
qmarcelle Aug 13, 2026
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
18 changes: 16 additions & 2 deletions README.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -10,7 +10,7 @@

<br />

<p align="center"><strong>Repository evidence that helps Codex plan around recorded risky changes.</strong></p>
<p align="center"><strong>The Codex adapter for workspace.json — repository evidence that helps Codex plan around recorded risky changes.</strong></p>

<p align="center"><code>@workspacejson/codex-mcp</code></p>

Expand All @@ -22,6 +22,20 @@

---

## Where this fits

`workspace.json` is a host-neutral open standard. The artifact is a committed file at `.agents/workspace.json`, and nothing in the format is specific to any editor, agent or vendor — any consumer can read it.

This repository holds **host adapters** for that standard. Codex is the adapter that exists today: the MCP server, the deterministic pre-edit hook, and an optional VS Code surface, published together as `@workspacejson/codex-mcp`. Further adapters can be added alongside it without the format changing, because the format does not know about any of them.

| Layer | Owned by |
| --- | --- |
| Format, schema, validation semantics | [`workspacejson/standard`](https://github.com/workspacejson/standard) |
| Artifact generation | [`workspacejson/cli`](https://github.com/workspacejson/cli) |
| Host adapters — this repository | [`workspacejson/integrations`](https://github.com/workspacejson/integrations) |

Everything below describes the Codex adapter specifically. Reading it as *the* way to consume `workspace.json` would invert the topology: the committed artifact is the interoperability point, and an integration does not become the standard.

## See it in 30 seconds

| | |
Expand Down Expand Up @@ -130,7 +144,7 @@ No configuration beyond step 1 above. On your own repo, the same deny path activ

### Provider-demo proof path — Billfold's one recorded partner

The judge-facing demo runs against [`workspace-json/billfold`](https://github.com/workspace-json/billfold), a small public payments service. This is a separate proof path from this repository's local `fixture/`: Billfold uses the single recorded pairing shown on camera, `src/routes/checkout.ts` and `src/webhooks/stripe.ts`; the local walkthrough above uses `src/auth/session.ts` and `src/lib/format.ts`.
The judge-facing demo runs against [`workspace-json/billfold`](https://github.com/workspace-json/billfold), a small public payments service. It is still hosted under the superseded `workspace-json` org, which is why its URL differs from the canonical namespace; the link is current and correct. This is a separate proof path from this repository's local `fixture/`: Billfold uses the single recorded pairing shown on camera, `src/routes/checkout.ts` and `src/webhooks/stripe.ts`; the local walkthrough above uses `src/auth/session.ts` and `src/lib/format.ts`.

```bash
git clone https://github.com/workspace-json/billfold.git
Expand Down
Loading