22B-Interior-Planning-Master-MCP: Instructions file for Codex

AGENTS.md

Documentation Style Guide

When writing or updating README.md or any documentation files, follow these rules strictly. These rules apply to ALL documentation tasks: new READMEs, updates, rewrites, and doc fixes.

Critical Rule: Structure Over Prose

The single most important rule: use tables and code blocks, not essays.

If you catch yourself writing more than 3 consecutive sentences without a table, code block, or heading, STOP and restructure.

BAD (essay style):

## Why This Exists

Most video tools ask for settings before they ask for taste.
That sounds efficient, but it usually produces generic work.
People do not think in "pacing_profile" and "camera_language" first.
They think in references, moods, instincts, and the strange combination
of things they already love. This project exists to close that gap.

GOOD (structured style):

## 소개 | Introduction

Shorts Engine은 좋아하는 영화, 영상 스타일, 작가 취향에서 출발해
숏폼 영상 시나리오를 자동으로 만드는 CLI 도구입니다.

Shorts Engine is a CLI tool that starts from your personal taste
and generates short-form video scenarios automatically.

Bilingual (Korean + English)

• Write every section in both Korean and English
• Korean comes first, English follows immediately after
• Section headers: ## 한글 제목 | English Title
• Table content: Korean and English in the same row where practical (e.g., 설명 Description column)
• Blockquotes and important notices: Korean line, then English line

BAD:

## What You Need
- n8n (`localhost:5678`)

GOOD:

## 필요한 환경 | Requirements

| 구성요소 Component | 설명 Description |
|------------------|-----------------|
| **n8n** | 워크플로우 엔진 (`localhost:5678`) |

Real Examples Required

• Every feature or tool MUST include a concrete usage example
• Show actual input (what the user types/says to the AI) in a code block
• Show actual output (JSON response, generated text, file content) in a code block
• Use realistic Korean data, not placeholder text
• Examples should demonstrate end-to-end workflow, not just API signatures