Docusaurus OpenAPI Docs is a Docusaurus plugin that turns OpenAPI or Swagger API specifications into MDX pages for API reference documentation. Teams use it to publish reference docs in Docusaurus sites, and the catalogue instruction relates to configuring or using this documentation workflow.
Borrowing it
Nothing to install: this file belongs to PaloAltoNetworks/docusaurus-openapi-docs. Take a copy, put it at the same path in your own repository, and replace the rules that are about this project with yours.
curl -O https://raw.githubusercontent.com/PaloAltoNetworks/docusaurus-openapi-docs/main/AGENTS.mdgit clone --depth 1 https://github.com/PaloAltoNetworks/docusaurus-openapi-docsWrote this? Show the measurements
A badge with what this costs and how it scanned, read live from this page, so it follows the numbers instead of freezing them. Markdown for a README, HTML for a documentation site or a project page.
[](https://agentmods.dev/instructions/paloaltonetworks/docusaurus-openapi-docs/agents-md)<a href="https://agentmods.dev/instructions/paloaltonetworks/docusaurus-openapi-docs/agents-md"><img src="https://agentmods.dev/badge/instructions/paloaltonetworks/docusaurus-openapi-docs/agents-md/github.svg" alt="Measured on agentmods" height="20"></a>Or the 80×15 button, for a site that already has a row of RSS and ATOM ones. Only the verdict fits; the numbers stay here.
<a href="https://agentmods.dev/instructions/paloaltonetworks/docusaurus-openapi-docs/agents-md"><img src="https://agentmods.dev/badge/instructions/paloaltonetworks/docusaurus-openapi-docs/agents-md.svg" alt="Reviewed on agentmods" width="80" height="20"></a>What it costs to keep this loaded
Counted locally with the o200k_base tokenizer, which is exact for GPT models; Claude uses its own tokenizer and its counts differ. Treat this as one consistent yardstick across the catalogue rather than a bill. Prices are per million input tokens.
| Model | Per session | Once invoked |
|---|---|---|
| Fable 5.1 | $0.01909 | $0.01909 |
| Opus 5.5 | $0.00764 | $0.00764 |
| Sonnet 5.5 | $0.00382 | $0.00382 |
| Haiku 4.5 | $0.00191 | $0.00191 |
Grade A, and why
docusaurus-openapi-docs AGENTS.md scanned grade A with 0 findings against 26 rules in 11 categories — prompt injection, anti-refusal, data exfiltration, privilege escalation, supply chain, agent snooping, system-prompt leakage, SSRF and excessive agency — measured today.
A static scan of the body, not an audit. Every finding is printed with the line that produced it so you can judge whether it matters here. A mod is markdown that instructs an agent; that is exactly why what it instructs is worth reading.
Nothing flagged
None of the 26 patterns this scan looks for appear in this file: no shell pipes, no recursive deletes, no credential paths, no hidden text, no instruction-override or anti-refusal phrasing, no agent-config snooping. That is not a guarantee, it is the absence of the things that are checkable.
How it starts
The opening of the file, as written. The whole thing — 212 lines — stays where its author put it; the contents beside it link to each section on GitHub.
Contributor Guide
This repository hosts the docusaurus-plugin-openapi-docs and docusaurus-theme-openapi-docs packages. The plugin converts OpenAPI specs to MDX and the theme provides React components for rendering those docs. The demo directory shows them working together.
root
├─ packages
│ ├─ docusaurus-plugin-openapi-docs # generates MDX from OpenAPI specs
│ └─ docusaurus-theme-openapi-docs # theme components for API docs
├─ demo # example site using the plugin and theme
└─ scripts # release and helper scripts
The plugin and theme are typically used together:
OpenAPI spec ──▶ plugin ──▶ generated MDX ──▶ docs plugin ──▶ theme ──▶ website
Developer Quick Start
Steps from the top-level README.md for getting started:
git clone https://github.com/<your account>/docusaurus-openapi-docs.git
cd docusaurus-openapi-docs
yarn
yarn build-packages
yarn watch:demo
Contributing Tips
See CONTRIBUTING.md for the full guide. Use clear commit messages so reviewers can understand what each commit does.
Required Checks
Run the following before committing any code changes (except documentation or comment-only updates):
yarn lint
yarn test
Other Common Tasks
yarn– install dependenciesyarn build-packages– compile all packages
Versioning and Releases
This project uses semantic versioning and Lerna for package management. Releases are triggered automatically when version changes are merged to main.
Version Types
| Bump Type | Example | When to Use |
|---|---|---|
patch |
4.5.0 → 4.5.1 |
Bug fixes, minor documentation updates |
minor |
4.5.1 → 4.6.0 |
New features, non-breaking enhancements |
major |
4.6.0 → 5.0.0 |
Breaking changes |
preminor |
4.5.1 → 4.6.0-rc.0 |
Pre-release for upcoming minor version |
prerelease |
4.6.0-rc.0 → 4.6.0-rc.1 |
Iterate on existing pre-release |
graduate |
4.6.0-rc.5 → 4.6.0 |
Promote pre-release to stable |
betamajor |
4.5.1 → 5.0.0-beta.0 |
Start a new beta major version |
betapatch |
5.0.0-beta.0 → 5.0.0-beta.1 |
Iterate on beta version |
What this file has done since we first saw it
Hashed on every crawl. A supply-chain change to an agent config is a question of when, not whether, so the history is kept rather than the latest state alone.
- today First seen · 212 lines · 1,909 tokens per session scan A 54ed8833dae2
docusaurus-openapi-docs AGENTS.md is an instructions file published in the GitHub repository PaloAltoNetworks/docusaurus-openapi-docs (1,107 stars, last pushed 2d ago), licensed MIT. It adds 1,909 tokens to every session, about $0.0076 per session on Opus 5.5. A static security scan graded it A with 0 findings. No closer match exists in the catalogue, so it is treated as the original; first seen 2026-11-07.
docusaurus-openapi-docs AGENTS.md compared with instructions from other repositories
| Mod | Type | Stars | Last push | Licence | Scan | Tokens | Works with |
|---|---|---|---|---|---|---|---|
| docusaurus-openapi-docs AGENTS.mdPaloAltoNetworks/docusaurus-openapi-docs | Instructions file | 1.1k | 2d ago | MIT | A | 1,909 | Codex, OpenCode |
| vscode buildNext.instructions.mdmicrosoft/vscode | Instructions file | 195k | today | MIT | A | 9,719 | GitHub Copilot |
| next.js AGENTS.mdvercel/next.js | Instructions file | 143k | today | MIT | A | 7,461 | Codex, OpenCode |
| vscode oss-third-party-notices.instructions.mdmicrosoft/vscode | Instructions file | 195k | today | MIT | A | 5,516 | GitHub Copilot |
| langchain AGENTS.mdlangchain-ai/langchain | Instructions file | 149k | today | MIT | A | 4,680 | Codex, OpenCode |
| vscode copilot-instructions.mdmicrosoft/vscode | Instructions file | 195k | today | MIT | A | 3,093 | GitHub Copilot |
| deepseek-harness AGENTS.mddeepseek-ai/deepseek-harness | Instructions file | 275k | 3d ago | MIT | A | 4,313 | Codex, OpenCode |