Home / canonry / canonry · GitHub

AGENTS.md@packages/provider-openaiA

AGENTS.md@packages/provider-openai from canonry/canonry is an AGENTS.md file: the standing instructions coding agents read in that repo.

Install it, pinned

mdr add canonry/canonry/packages/provider-openai/AGENTS.md@git:20261015.c8ecbd8

Pins git:20261015.c8ecbd8 in mdr.lock. Pin the fingerprint instead.

Audit grade: A, 14 of 14 checks passed
Kind: AGENTS.md file
Repository: canonry/canonry
Path: packages/provider-openai/AGENTS.md
Versions recorded: 9
Latest version: git:20261015.c8ecbd8, committed Oct 15, 2026
First version recorded: Apr 4, 2026
Size: 4,104 bytes
Repository stars: 199
License: MIT

Collected from public GitHub. Every version is saved exactly as it was and never changes. Install it at an exact version with the mdr tool, and every file is checked before it reaches your agent. The main file is checked against the SHA-256 fingerprint recorded here, and the others against the fingerprints GitHub keeps for its source commit. The automatic checks below grade the latest version, and the same checks always give the same file the same grade.

What the file says

# provider-openai

## Purpose

OpenAI adapter — implements `ProviderAdapter` for OpenAI's Responses API using the `web_search` tool (the current GA tool, chosen over the legacy `web_search_preview`; its new knobs — e.g. `filters.allowed_domains` — stay off because allow-listing would defeat measuring who actually gets cited). Extracts cited domains from URL annotations.

## Key Files

| File | Role |
|------|------|
| `src/adapter.ts` | Exports `openaiAdapter` — the `ProviderAdapter` object |
| `src/normalize.ts` | Core logic: `validateConfig`, `healthcheck`, `buildTrackedQueryRequest`, `executeTrackedQuery`, `parseTrackedQueryResponse`, `normalizeResult`, `generateText` |
| `src/types.ts` | OpenAI-specific config and response types |
| `src/index.ts` | Re-exports public API |

## Patterns

All provider packages follow the same 4-file structure and implement the same `ProviderAdapter` interface from `@canonry/canonry-contracts`:

- **`validateConfig(config)`** — verify API key and model are valid
- **`healthcheck(config)`** — test connectivity to the provider
- **`executeTrackedQuery(input)`** — send a tracked query and capture raw response with web search results
…

Read the whole file at its exact version.

How to install

The exact contents, by fingerprint

mdr add canonry/canonry/packages/provider-openai/AGENTS.md@sha256:af1678c7a8d1d538

The line at the top of this page pins the label git:20261015.c8ecbd8, which is what most people want. This one pins the sha256 fingerprint of the contents instead, so it survives a label being moved. Either way the exact version is written to mdr.lock, and mdr install downloads and checks those contents again, so it installs them exactly or stops with an error.

Badge

[![mdr](https://markdownregistry.com/badge/art_4pttmztssdfoerbd.svg)](https://markdownregistry.com/a/art_4pttmztssdfoerbd)

4 badge image fetches in 30 days. What the badge shows.

Versions

The registry has recorded 9 versions of this file, between Apr 4, 2026 and Oct 15, 2026, about one every 24 days.

version	committed	commit	size	audit
git:20261015.c8ecbd8 latest	2026-10-15	c8ecbd8	4,104 B	A	view · diff
git:20261008.df2022e	2026-10-08	df2022e	4,102 B	A	view · diff
git:20261006.9ddd0d5	2026-10-06	9ddd0d5	3,708 B	A	view · diff
git:20260928.6369ada	2026-09-28	6369ada	3,193 B	A	view · diff
git:20260927.b00090f	2026-09-27	b00090f	2,801 B	A	view · diff
git:20260711.87b75e9	2026-07-11	87b75e9	2,193 B	A	view · diff
git:20260517.325635e	2026-05-17	325635e	2,110 B	A	view · diff
git:20260506.fe0fe1b	2026-05-06	fe0fe1b	1,773 B	A	view · diff
git:20260404.39669fe	2026-04-04	39669fe	1,773 B	A	view

Audit of the latest version

A 14 of 14 checks passed. Fixed automatic checks with no AI involved, so the same checks give the same answer every run.

pass: Size between 200 bytes and 200 KB (4104 bytes)
pass: No zero-width or bidi control characters
pass: No instruction hidden inside an HTML comment
pass: No link to an exfiltration or paste host
pass: No credential-shaped string
pass: No instruction to send local credentials anywhere
pass: No text hidden with inline styles
pass: No prompt-injection phrasing
pass: No curl or wget piped into a shell
pass: No recursive delete of root, home or parent
pass: No instruction to read or print local credentials
pass: No base64 blob over 200 characters
pass: No link to a raw IP address
pass: No script tag

Source

GitHub

canonry/canonry · 199 stars · license MIT · pushed 2026-11-08 · branch main

API

GET https://markdownregistry.com/api/v1/artifacts/art_4pttmztssdfoerbd
GET https://markdownregistry.com/api/v1/resolve?ref=canonry/canonry/packages/provider-openai/AGENTS.md
GET https://markdownregistry.com/api/v1/blob/af1678c7a8d1d538150cb20b08739b3bed2eaf64c1e615898f56e86ac5535843

Your AI assistant does the legwork. You hear about the deals worth your word. Hand yours the standing instructions at modelranch.com and it joins the network that reads files like this one.

Guides: how to write a good AGENTS.md · AGENTS.md vs CLAUDE.md · which agent file does what.

More from canonry/canonry

test-audit SKILL.md skill

canonry/canonry · .agents/skills/test-audit/SKILL.md · Invoke whenever writing, changing, reviewing, running, or sweeping Canonry tests. Authoring gate for new tests plus…

git:20261015.3a14a05 · audit A · 199 stars

AGENTS.md AGENTS.md file

canonry/canonry · AGENTS.md

git:20261101.8b16fda · audit A · 199 stars

DESIGN.md DESIGN.md file

canonry/canonry · DESIGN.md

git:20261102.cd516b0 · audit A · 199 stars

AGENTS.md@apps/api AGENTS.md file

canonry/canonry · apps/api/AGENTS.md

git:20261007.254a7fb · audit A · 199 stars

AGENTS.md@apps/mcp-gateway AGENTS.md file

canonry/canonry · apps/mcp-gateway/AGENTS.md