What is open-swagger-ui AGENTS.md?

A project instruction file for open-swagger-ui, an npm package and command-line tool that opens Swagger or OpenAPI files in Swagger UI. It documents the architecture, supported builds, compatibility requirements, and rules for coding agents.

Use it when developing, reviewing, building, or maintaining the open-swagger-ui package and its command-line tool.

It gives agents a shared source of truth so changes preserve the package's public API, command-line behavior, and support for older Node.js versions. Swagger and OpenAPI are formats for describing web APIs.

How vajahath/open-swagger-ui configures Codex and OpenCode

Reuse

Borrowing it

Nothing to install: this file belongs to vajahath/open-swagger-ui. Take a copy, put it at the same path in your own repository, and replace the rules that are about this project with yours.

Copy the file

curl -O https://raw.githubusercontent.com/vajahath/open-swagger-ui/main/AGENTS.md

Clone the repo

git clone --depth 1 https://github.com/vajahath/open-swagger-ui

Made for: Codex, OpenCode.

Wrote 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.

README.md

[![agentmods](https://agentmods.dev/badge/instructions/vajahath/open-swagger-ui/agents-md/github.svg)](https://agentmods.dev/instructions/vajahath/open-swagger-ui/agents-md)

Your own site

<a href="https://agentmods.dev/instructions/vajahath/open-swagger-ui/agents-md"><img src="https://agentmods.dev/badge/instructions/vajahath/open-swagger-ui/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.

Your own site · 80×15

<a href="https://agentmods.dev/instructions/vajahath/open-swagger-ui/agents-md"><img src="https://agentmods.dev/badge/instructions/vajahath/open-swagger-ui/agents-md.svg" alt="Reviewed on agentmods" width="80" height="20"></a>

Per session 1,189 This file is loaded in full into every session.

When invoked 1,189 The same file — it is already loaded in full.

Security scan A 0 findings. A grade says what 26 rules found in the file — not that it is safe.

Origin original No closer match found in the catalogue.

Token cost

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.01189	$0.01189
Opus 5.5	$0.00476	$0.00476
Sonnet 5.5	$0.00238	$0.00238
Haiku 4.5	$0.00119	$0.00119

Measured yesterday against content hash bbab52f8057b, method: parsed. Prices are Anthropic first-party input rates as of 2026-10-07, from the pricing page.

Security

Grade A, and why

open-swagger-ui 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 yesterday.

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.

AGENTS.md · 81 lines

How it starts

The opening of the file, as written. The whole thing — 81 lines — stays where its author put it; the contents beside it link to each section on GitHub.

AGENTS.md - Multi-Agent Operating Guide

This repository contains open-swagger-ui, an npm package and CLI tool used to preview Swagger/OpenAPI files in Swagger UI.

Project Overview

open-swagger-ui starts an Express server to preview Swagger/OpenAPI (.json or .yaml) specifications in Swagger UI. It supports both CLI usage (open-swagger-ui <file> [options]) and programmatic usage (startServerWithSwaggerFile(file, port)).

Core Architecture & Dual Build

Bundler: Built with tsdown (powered by Rolldown + Oxc).
Dual Outputs:
- CommonJS: dist/index.cjs (targeting Node >= 10)
- ESM: dist/index.mjs (for modern ESM consumers and bundlers)
- CLI Binary: dist/bin/open-swagger-ui.cjs
- Types: dist/index.d.ts, dist/index.d.cts, and dist/index.d.mts
Configuration: tsdown.config.mts

Golden Rules for Agents Working on this Codebase

Zero Breaking Changes: This package has active downloads. Maintain the public API interface startServerWithSwaggerFile(file, requestedPort) and CLI flag behavior exactly as documented.
Node.js Engine Floor (>= 10): All runtime bundle output and dependencies must run on Node.js 10+. Never convert the package to ESM-only or upgrade dependencies to versions that drop Node 10 or CJS support.
Dual Build Contract: Emitted files in dist/ must include both .cjs and .mjs variants with appropriate .d.ts definitions.
Always Verify Locally First & with Docker: Run npm test, npm run test:compat, and npm run test:docker (or verify with scripts/test-compat.cjs in a container) to confirm Node 10 backward compatibility. Local testing is the primary means; CI is a fallback.
Release Restraint: Never publish to npm or push directly to remote branches without explicit user permission.
Consumer Verification Gate: Run npm run test:consumer to verify real-world package installation, native ESM imports, CommonJS requires, TypeScript type compilation (0 TS7016 errors), and CLI binary execution.

Read the full file on GitHub · 81 lines

Changes

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.

yesterday First seen · 81 lines · 1,189 tokens per session scan A bbab52f8057b

Subscribe to this mod's changes

open-swagger-ui AGENTS.md is an instructions file published in the GitHub repository vajahath/open-swagger-ui (16 stars, last pushed 7d ago), licensed MIT. It adds 1,189 tokens to every session, about $0.0048 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-08.

Backend and APIs cli javascript npm swagger swagger-cli swagger-ui

open-swagger-ui AGENTS.md next to 6 instructions from other repositories
Mod	Type	Stars	Last push	Licence	Scan	Tokens	Works with
open-swagger-ui AGENTS.mdvajahath/open-swagger-ui	Instructions file	16	7d ago	MIT	A	1,189	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
vscode ai-customization.instructions.mdmicrosoft/vscode	Instructions file	195k	today	MIT	A	1,907	GitHub Copilot

open-swagger-ui: Instructions file for Codex