omg

Convert OMG Markdown definitions into OpenAPI 3.1 specifications.

1|Updated Dec 18, 2025

Search Tags:#documentation #api #openapi #specification #endpoints #schemas

Ready to run

npx skills add https://github.com/mcclowes/omg --skill omg

💬 Prompt for ChatGPT / Claude Chat▼

Please help me install this Agent Skill.
Skill: omg
Source: https://github.com/mcclowes/omg/tree/main/.claude/skills/omg
Command: npx skills add https://github.com/mcclowes/omg --skill omg

SYSTEM DOCUMENTATION & REQUIREMENTS

What problem does it solve?

This Skill removes the tedious YAML syntax of OpenAPI specifications by letting you write API documentation in simple markdown format.

Core Features & Use Cases

API Documentation: Create comprehensive OpenAPI 3.1 specifications from human-readable markdown files.

Core Features & Use Cases

Endpoint Specification: Define API paths, parameters, and responses using intuitive markdown syntax.
Schema Generation: Define reusable data models with JSON Schema validation built-in.

Quick Start

Convert this markdown API description into a valid OpenAPI specification.

Frequently Asked Questions about omg

High-intent search queries and answers about installing and using this skill.

FAQPage Schema

How do I convert markdown to OpenAPI specifications?▼

Convert markdown to OpenAPI 3.1 specifications using OMG Markdown format. Write API endpoints, parameters, and responses in .omg.md files using omg.path, omg.query, omg.body, and omg.response blocks, then compile to valid OpenAPI YAML output via CLI.

Can I skip writing YAML for API documentation?▼

Yes. OMG lets you write API documentation in human-readable markdown instead of YAML syntax. Define endpoints, schemas, and parameters in markdown format and automatically generate OpenAPI 3.1 specifications without manual YAML editing.

What markdown syntax does OMG use for API endpoints?▼

OMG uses dedicated markdown blocks: omg.path for endpoints, omg.query for query parameters, omg.body for request bodies, and omg.response for responses. It supports a strict type system including string, integer, boolean, date, datetime, uuid, and constraints like @min.

Does OMG support reusable schema definitions?▼

Yes. OMG supports partial schema reuse within .omg.md files. Define data models once with JSON Schema validation built-in, then reference them across multiple endpoints to avoid duplication.

Can I use OMG with optional fields and arrays?▼

Yes. OMG's type system supports optional fields, arrays, enums, and validation constraints. Compile these definitions into OpenAPI 3.1 specifications that include full JSON Schema validation.

What's the best way to manage API documentation with markdown instead of YAML?▼

Use OMG to define API endpoints in markdown .omg.md files with intuitive blocks for paths, parameters, and responses. The CLI builds these into valid OpenAPI 3.1 YAML specifications, reducing syntax complexity and improving readability.