Home / canonry / canonry · GitHub

AGENTS.md@packages/api-client-generatedA

AGENTS.md@packages/api-client-generated 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/api-client-generated/AGENTS.md@git:20261020.3ca6ab5

Pins git:20261020.3ca6ab5 in mdr.lock. Pin the fingerprint instead.

Audit grade: A, 14 of 14 checks passed
Kind: AGENTS.md file
Repository: canonry/canonry
Path: packages/api-client-generated/AGENTS.md
Versions recorded: 6
Latest version: git:20261020.3ca6ab5, committed Oct 20, 2026
First version recorded: May 17, 2026
Size: 3,908 bytes
Repository stars: 193
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

# api-client

## Purpose

Generated TypeScript client for the canonry HTTP API. Single source of truth for request/response types across the CLI (`packages/canonry`), web SPA (`apps/web`), and MCP adapter (`packages/canonry/src/mcp/`).

The generator (`@hey-api/openapi-ts`) reads the spec emitted by `packages/api-routes` (via `buildOpenApiDocument()`) and writes typed services into `src/generated/`. Consumers import named operations from the barrel — there is no hand-written client wrapper.

## Layout

```
codegen.ts            # generation script — `pnpm gen`
src/
  index.ts            # public barrel (re-exports generated services + types + createClient)
  generated/          # hey-api output (committed, regenerated by pnpm gen)
test/
  smoke.test.ts       # SDK request wiring checks (Vitest)
  *.test-d.ts         # Public SDK type contracts (typecheck)
tsconfig.test.json   # compiler-checks source, runtime tests, and type contracts
```

## Commands

```bash
pnpm --filter @canonry/canonry-api-client gen        # regenerate src/generated
pnpm --filter @canonry/canonry-api-client gen:check  # compare temporary output with src/generated
…

Read the whole file at its exact version.

How to install

The exact contents, by fingerprint

mdr add canonry/canonry/packages/api-client-generated/AGENTS.md@sha256:27916a66367a2cec

The line at the top of this page pins the label git:20261020.3ca6ab5, 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_kfp54j2bwf4i7uo2.svg)](https://markdownregistry.com/a/art_kfp54j2bwf4i7uo2)

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

Versions

The registry has recorded 6 versions of this file, between May 17, 2026 and Oct 20, 2026, about one every 31 days.

version	committed	commit	size	audit
git:20261020.3ca6ab5 latest	2026-10-20	3ca6ab5	3,908 B	A	view · diff
git:20261015.c8ecbd8	2026-10-15	c8ecbd8	3,902 B	A	view · diff
git:20261006.9ddd0d5	2026-10-06	9ddd0d5	3,892 B	A	view · diff
git:20261003.bc9c8ba	2026-10-03	bc9c8ba	3,791 B	A	view · diff
git:20260908.f6b799a	2026-09-08	f6b799a	3,442 B	A	view · diff
git:20260517.ecc4d06	2026-05-17	ecc4d06	2,756 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 (3908 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 · 193 stars · license MIT · pushed 2026-10-23 · branch main

API

GET https://markdownregistry.com/api/v1/artifacts/art_kfp54j2bwf4i7uo2
GET https://markdownregistry.com/api/v1/resolve?ref=canonry/canonry/packages/api-client-generated/AGENTS.md
GET https://markdownregistry.com/api/v1/blob/27916a66367a2cec5af7fe22eed948bba0e96d351e505440c2919b0fc7fb95d9

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 · 193 stars

AGENTS.md AGENTS.md file

canonry/canonry · AGENTS.md

git:20261020.3ca6ab5 · audit A · 193 stars

DESIGN.md DESIGN.md file

canonry/canonry · DESIGN.md

git:20261010.862ea14 · audit A · 193 stars

AGENTS.md@apps/api AGENTS.md file

canonry/canonry · apps/api/AGENTS.md

git:20261007.254a7fb · audit A · 193 stars

AGENTS.md@apps/vals/ai-visibility-check AGENTS.md file

canonry/canonry · apps/vals/ai-visibility-check/AGENTS.md