openapi

A Vovk.ts guide for generating OpenAPI 3.x descriptions from backend procedures and validation schemas. OpenAPI is a standard machine-readable description of an HTTP API that tools can use to document or inspect it.

In plain words
What is it for?
Use it to map parameters, queries, schemas, summaries, tags, security settings, deprecated operations, and known errors into an OpenAPI document. It also explains serving the document for viewers such as Scalar, Redoc, or Swagger UI.
Why use it?
It keeps API documentation connected to the code and avoids writing a separate description for every endpoint.

Skill for Claude CodeCodex

Install

Getting it into your agent

One page per mod, every tool's command on it. A separate URL per tool would split the same page into five that compete with each other.

agentmods
npx agentmods add skills/finom/vovk/openapi
Any agent
npx skills add finom/vovk --skill openapi
Clone the repo
git clone --depth 1 https://github.com/finom/vovk

Made for: Claude Code, Codex.

Per session 320 Skills are progressive disclosure: only the name and description are preloaded; the body loads when the skill is used.
When invoked 3,846 The whole file, excluding the scripts and references it only reads on demand.
Security scan A 0 findings. Scan, not verified.
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.

ModelPer sessionOnce invoked
Fable 5 $0.00320 $0.03846
Opus 5 $0.00160 $0.01923
Sonnet 5 $0.00064 $0.00769
Haiku 4.5 $0.00032 $0.00385

Measured 2d ago against content hash 319faee7328d, method: parsed. Prices are Anthropic first-party input rates as of 2026-08-30, from the pricing page.

Security

Grade A, and why

openapi 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 2d ago.

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.

skills/openapi/SKILL.md · 366 lines

How it starts

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

Vovk.ts OpenAPI

OpenAPI 3.x spec is byproduct of code you already write. Procedures + validation schemas + @operation metadata → spec. No separate doc authoring.

Scope

Covers:

  • What gets mapped to what (schemas → OpenAPI fields).
  • @operation({...}) — summary, description, tags, security, deprecated, any OpenAPI 3.1 OperationObject field.
  • @operation.error(status, message) — document known error responses.
  • @operation.tool({...}) — AI-tool metadata (x-tool). Read by deriveTools; full usage in tools skill.
  • Global OpenAPI object (outputConfig.openAPIObject).
  • Per-segment overrides (outputConfig.segments.<name>.openAPIObject).
  • Accessing the spec: import { openapi } from 'vovk-client/openapi'.
  • Serving spec JSON from controller so any OpenAPI viewer (Scalar, Redoc, Swagger UI) can point at it.

Out of scope:

  • Writing procedures / schemas → procedure skill.
  • deriveTools() / createTool() / MCP wiring → tools skill.
  • Third-party OpenAPI codegen → mixins skill.

How procedures map to OpenAPI

Procedure field OpenAPI output
params schema parameters with in: 'path'
query schema parameters with in: 'query'
body schema requestBody (content type from contentType, default application/json)
output schema responses.200 with application/json
iteration schema responses.200 with application/jsonl
@operation fields operation-level metadata (summary, description, tags, etc.)

Anything expressible in procedure() call — request shape, response shape, content type — lands in spec automatically.

@operation decorator family

Three decorators, same namespace, all attached to operation:

Decorator Writes to Purpose
@operation({...}) operationObject Standard OpenAPI metadata (summary, description, tags, deprecated, security, …). Accepts any field from OpenAPI 3.1's OperationObject.
@operation.error(status, message) operationObject.responses[status] Document a known error shape. Generates response referencing #/components/schemas/VovkErrorResponse with message pinned to a literal.
@operation.tool({...}) operationObject['x-tool'] AI-tool metadata read by deriveToolsname, description, title, hidden. See tools skill for full usage.

Read the full file on GitHub · 366 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.

  1. 2d ago First seen · 366 lines · 320 tokens per session scan A 319faee7328d

Subscribe to this mod's changes

openapi is a skill published in the GitHub repository finom/vovk (52 stars, last pushed 5d ago), licensed MIT. It adds 320 tokens to every session and 3,846 once invoked, about $0.0016 per session on Opus 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-08-30.

Related

Other skills, from other repositories

ocli-api

Turn any OpenAPI/Swagger API into CLI commands and call them. Search endpoints with BM25, check parameters, execute — no MCP server needed.

EvilFreelancer/openapi-to-cli · 34 tokens

react-performance

Optimize React/Next.js runtime performance — eliminate waterfalls, shrink bundles, cut unnecessary re-renders, and speed up rendering. Use when writing, reviewing, or refactoring components for speed, or chasing slow renders, large bundles, janky interactions, or high TTFB/LCP/INP.

clubpay/ronykit · 64 tokens

ronykit-framework

Orchestrates RonyKit service development using the ronyup MCP server (knowledge resources, prompts, scaffold tools). Use when the user mentions RonyKit, ronyup, EdgeServer, contracts, scaffolding a workspace or feature, implementing API handlers and services, frontend bootstrap, integration tests, or design documents…

clubpay/ronykit · 75 tokens

composition-patterns

Design reusable React component APIs that scale — compound components, lifted state, generic context, explicit variants. Use when a component is growing boolean props (isThread, isEditing…), when building a component library, or when reviewing component architecture. Includes React 19 API changes.

clubpay/ronykit · 58 tokens

storybook

Author and maintain Storybook stories with CSF 3.0 best practices — args, decorators, parameters, and config. Use when creating or editing .stories. files, configuring .storybook/, or ensuring every UI component ships with stories.

clubpay/ronykit · 50 tokens

webmcp

Build agent-friendly web apps with the W3C Web Model Context API (WebMCP). Use when exposing frontend features as structured tools for in-browser AI agents, adding document.modelContext tools to React/Next.js apps, designing tool schemas for dashboards or admin UIs, or making existing UI automatable without DOM…

clubpay/ronykit · 69 tokens