write-api-reference SKILL.md skillA

write-api-reference from vercel/next.js is an agent skill: a SKILL.md folder an AI agent loads when a task calls for it.

Install it, pinned
mdr add vercel/next.js/write-api-reference@git:20260526.3da1803

Pins git:20260526.3da1803 in mdr.lock. Pin the fingerprint instead.

Audit grade
A, 17 of 17 checks passed
Kind
SKILL.md skill
Repository
vercel/next.js
Path
.agents/skills/write-api-reference/SKILL.md
Versions recorded
3
Latest version
git:20260526.3da1803, committed May 26, 2026
First version recorded
Mar 13, 2026
Size
8,704 bytes
Repository stars
143,627
License
MIT

Produces API reference documentation for Next.js APIs: functions, components, file conventions, directives, and config options. **Auto-activation:** User asks to write, create, or draft an API reference page. Also triggers on paths like `docs/01-app/03-api-reference/`, or keywords like "API reference", "props", "parameters", "returns", "signature". **Input sources:** Next.js source code, existing API reference pages, or user-provided specifications. **Output type:** A markdown (.mdx) API…

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

# Writing API Reference Pages

## Goal

Produce an API reference page that documents a single API surface (function, component, file convention, directive, or config option). The page should be concise, scannable, and example-driven.

Each page documents **one API**. If the API has sub-methods (like `cookies.set()`), document them on the same page. If two APIs are independent, they get separate pages.

## Structure

Identify which category the API belongs to, then follow the corresponding template.

### Categories

1. **Function** (`cookies`, `fetch`, `generateStaticParams`): signature, params/returns, methods table, examples
2. **Component** (`Link`, `Image`, `Script`): props summary table, individual prop docs, examples
3. **File convention** (`page`, `layout`, `route`): definition, code showing the convention, props, behavior, examples
4. **Directive** (`use client`, `use cache`): definition, usage, serialization/boundary rules, reference
5. **Config option** (`basePath`, `images`, etc.): definition, config code, behavioral sections

### Template

````markdown
---
title: {API name}
…

Read the whole file at its exact version.

How to install

No tool to install first
claude plugin marketplace add https://markdownregistry.com/mp/a/art_dddvafxipk66ki7b/6c9253dee9cfeb0bacc474529b88605dbc72fb6fdd0091e8422d76f5d55c0cc9.json

Then /plugin install write-api-reference@markdownregistry-dddvafxipk66ki7b in Claude Code. It installs git:20260526.3da1803, the one graded A here, pinned to the commit it was graded at, and leaves it there.

The exact contents, by fingerprint
mdr add vercel/next.js/write-api-reference@sha256:6c9253dee9cfeb0b

The line at the top of this page pins the label git:20260526.3da1803, 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 badge

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

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

Ask from your agent
claude mcp add --transport http markdownregistry https://markdownregistry.com/mcp/registry

Then ask it: what changed in vercel/next.js/write-api-reference since the version I have? It reads every saved version here, no key and no account. Any agent that speaks MCP can add it.

Got a copy of write-api-reference from somewhere else? Ask it: where did my write-api-reference come from, and what was changed? It names the public original, the version yours is closest to and every changed line. The text is not kept.

Versions

The registry has recorded 3 versions of this file, between Mar 13, 2026 and May 26, 2026, about one every 37 days.

Watch this file (sign in, one email per new version)

versioncommittedcommitsizeaudit
git:20260526.3da1803 latest2026-05-26 3da1803 8,704 BA view · diff
git:20260514.30421ba2026-05-14 30421ba 7,547 BA view · diff
git:20260313.fb0686d2026-03-13 fb0686d 7,520 BA view
Keep it current by itself, install once

Committed this skill to a repository? Install the markdownregistry skill updates app on it, or on all of them. When the registry saves a newer version, a pull request brings your copy to it within minutes, the newest version first, then what changed and any check it newly trips. A copy you edited is never touched, and nothing is deleted.

Install on GitHub

It asks to read and write contents and pull requests, and to read metadata. No workflow file, no Actions setting, nothing runs on your runners. Uninstall it and everything the registry kept about your repository is deleted.

Keep it current by itself

Committed this skill to a repository? Add one workflow file, and when a newer version is saved, a pull request brings your copy to it, the newest version first, then what changed and any check it newly trips. A copy you edited is never touched, and nothing is deleted.

mkdir -p .github/workflows && curl -fsSL https://markdownregistry.com/ci/skill-updates.yml -o .github/workflows/skill-updates.yml

It runs daily on GitHub Actions, no key and no account. Read the workflow before you add it.

Check a whole project

From the root of your project, one line hashes each installed skill's SKILL.md, your AGENTS.md and your CLAUDE.md, and asks the registry once. Only the fingerprints and paths are sent.

sha256sum .claude/skills/*/SKILL.md AGENTS.md CLAUDE.md | curl -s --data-binary @- https://markdownregistry.com/api/v1/check-copies

In CI, add --fail-with-body: the answer is 409 when any file is behind, so the step fails and still prints which files.

sha256sum .claude/skills/*/SKILL.md AGENTS.md CLAUDE.md | curl -s --fail-with-body --data-binary @- https://markdownregistry.com/api/v1/check-copies

No sha256sum on your machine? shasum -a 256 prints the same lines.

Audit of the latest version

A  17 of 17 checks passed. Fixed automatic checks with no AI involved, so the same checks give the same answer every run.
  • pass: Frontmatter block present
  • pass: Frontmatter declares a name
  • pass: Frontmatter declares a description
  • pass: Size between 200 bytes and 200 KB (8704 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

vercel/next.js · 143,627 stars · license MIT · pushed 2026-11-21 · branch canary

API

GET https://markdownregistry.com/api/v1/artifacts/art_dddvafxipk66ki7b
GET https://markdownregistry.com/api/v1/resolve?ref=vercel/next.js/write-api-reference
GET https://markdownregistry.com/api/v1/blob/6c9253dee9cfeb0bacc474529b88605dbc72fb6fdd0091e8422d76f5d55c0cc9

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: the SKILL.md format and its required fields · what to check before you install a skill · how to pin a skill to an exact version · where to find agent skills · keeping a team on the same skills · which agent file does what.

More from vercel/next.js

authoring-skills SKILL.md skill
vercel/next.js · .agents/skills/authoring-skills/SKILL.md · How to create and maintain agent skills in .agents/skills/. Use when creating a new SKILL.md, writing skill…
git:20260514.30421ba · audit A · 143,627 stars
backport-pr SKILL.md skill
vercel/next.js · .agents/skills/backport-pr/SKILL.md · Backport a merged Next.js pull request from canary to an LTS release branch (releases/lts/active or…
git:20261022.9ff761f · audit A · 143,627 stars
create-pr SKILL.md skill
vercel/next.js · .agents/skills/create-pr/SKILL.md · Create Git branches, commits, pushes, and GitHub pull requests for Next.js. Use when the user asks to create a branch…
git:20261116.3f293ac · audit A · 143,627 stars
dce-edge SKILL.md skill
vercel/next.js · .agents/skills/dce-edge/SKILL.md · DCE-safe require() patterns and edge runtime constraints. Use when writing conditional require() calls, guarding…
git:20260514.30421ba · audit A · 143,627 stars
deploy-release-test SKILL.md skill
vercel/next.js · .agents/skills/deploy-release-test/SKILL.md · Validate a commit-specific Next.js preview package and manually trigger the entire Next.js deployment test suite…
git:20260827.89ba4a3 · audit A · 143,627 stars
docs-diagrams SKILL.md skill
vercel/next.js · .agents/skills/docs-diagrams/SKILL.md · Draw diagrams for the Next.js docs in the style of the ones already published there: the light/dark PNGs an mdx…
git:20261026.6352f41 · audit A · 143,627 stars
flags SKILL.md skill
vercel/next.js · .agents/skills/flags/SKILL.md · How to add or modify Next.js experimental feature flags end-to-end. Use when editing config-shared.ts…
git:20260622.e7f4e33 · audit A · 143,627 stars
gate-tests SKILL.md skill
vercel/next.js · .agents/skills/gate-tests/SKILL.md · How to use the `@gate` / `@force-gate` test directives instead of `it.skip` or fake-green skip patterns. Use when a…
git:20261105.7fb24bf · audit A · 143,627 stars
gh-stack SKILL.md skill
vercel/next.js · .agents/skills/gh-stack/SKILL.md · Manages stacked PRs and splits multi-part work into reviewable branches with gh-stack. Use for stack creation, viewing…
v0.1.0 · audit A · 143,627 stars
insight-error-page SKILL.md skill
vercel/next.js · .agents/skills/insight-error-page/SKILL.md · Write or audit an insight-kind error page for the Next.js dev overlay. Use when creating a new `errors/<slug>.mdx`…
git:20260708.76628b4 · audit A · 143,627 stars
next-rspack SKILL.md skill
vercel/next.js · .agents/skills/next-rspack/SKILL.md · Maintain @next/rspack-core and @next/rspack-binding packages. Use when editing rspack/package.json…
git:20260622.c505af9 · audit A · 143,627 stars
pr-status-triage SKILL.md skill
vercel/next.js · .agents/skills/pr-status-triage/SKILL.md · Triage CI failures and PR review comments using scripts/pr-status.js. Use when investigating failing CI jobs, flaky…
git:20261112.c06d76e · audit A · 143,627 stars

Every file in vercel/next.js

Browse by kind, by grade A, or by owner.

Kept in .agents/skills, the folder Codex reads. More agent skills for Codex.