AgentRules.org
RulesStacksClientsAuditorPrunerSelf-HealRFCsBenchmarkCLICI/CDAuthorsSubmit
This specification is maintained by the AgentRules Working Group. Have enhancements or want to claim maintainership?Submit Specification →
backendcritical PriorityID: openai-structured-outputs-zod

OpenAI Structured Outputs & Zod Strict JSON Schema Enforcement

Production standard for deterministic LLM tool calling and structured outputs. Mandates native response_format: zodResponseFormat with strict: true, eliminates flaky regex markdown code-block parsing, and guarantees 100% schema compliance.

Prohibited Anti-Pattern: AI writes brittle regex to strip ```json code fences from LLM text responses, crashing on omitted fields.

Export Ready-to-Drop Configuration

Select format below to copy code or download file directly.

---
description: OpenAI Structured Outputs & Zod Strict JSON Schema Enforcement - Production standard for deterministic LLM tool calling and structured outputs. Mandates native response_format: zodResponseFormat with strict: true, eliminates flaky regex markdown code-block parsing, and guarantees 100% schema compliance.
globs: **/*openai*.ts, **/*llm*.ts, **/*ai*.py
alwaysApply: true
verified_by: "agentrules.org"
license: "CC-BY-4.0"
source: "https://agentrules.org/rules/openai-structured-outputs-zod"
---

# OpenAI Structured Outputs & Zod Strict JSON Schema Enforcement

> **Severity**: CRITICAL | **Category**: backend
> **Anti-Pattern Warning**: AI writes brittle regex to strip ```json code fences from LLM text responses, crashing on omitted fields.

## System Constraints
You are an AI infrastructure and LLM systems engineer. When requesting structured JSON from OpenAI models (gpt-4o, gpt-4o-mini, o1), NEVER prompt with natural language 'Please output JSON' and parse raw text. Always use response_format: zodResponseFormat() with strict: true in TypeScript or parse with Pydantic in Python.

## Strict Guidelines
- Always use openai.beta.chat.completions.parse() with zodResponseFormat(Schema, 'name') for guaranteed schema adherence.
- Ensure all Zod schema fields are explicitly marked or nullable; strict mode rejects optional fields without explicit defaults or nullability.
- Check completion.choices[0].message.refusal to gracefully handle safety refusals before accessing parsed fields.
- Never perform manual regex stripping of '```json' or JSON.parse on unstructured message.content.

## Bad vs Good Implementations
### Native Structured Outputs (zodResponseFormat) vs Brittle Regex Parsing

#### Bad Antipattern (AI Common Hallucination)
> **Why it fails**: Fails randomly when models prepend conversational text or omit required keys under temperature variance.
```typescript
// ANTI-PATTERN: Prompting for JSON and stripping markdown fences with regex
const res = await openai.chat.completions.create({
  model: "gpt-4o",
  messages: [{ role: "user", content: "Analyze this resume and return JSON { name, skills }" }],
});
const text = res.choices[0].message.content || "";
const cleaned = text.replace(/```json/g, "").replace(/```/g, "").trim();
const data = JSON.parse(cleaned); // SyntaxError: Unexpected token
```

#### Production Standard (Correct)
> **Standard**: OpenAI constrained decoding enforces CFG grammar directly at the token generation stage, making schema violations mathematically impossible.
```typescript
// PRODUCTION STANDARD: OpenAI Native Structured Outputs with Zod
import OpenAI from "openai";
import { zodResponseFormat } from "openai/helpers/zod";
import { z } from "zod";

const client = new OpenAI();
const CandidateSchema = z.object({
  candidateName: z.string(),
  yearsOfExperience: z.number().int(),
  topSkills: z.array(z.string()),
  recommendation: z.enum(["hire", "hold", "reject"]),
});

export async function analyzeResume(resumeText: string) {
  const res = await client.beta.chat.completions.parse({
    model: "gpt-4o-2024-08-06",
    messages: [{ role: "user", content: resumeText }],
    response_format: zodResponseFormat(CandidateSchema, "candidate_analysis"),
  });
  return res.choices[0].message.parsed;
}
```

### Python Pydantic Structured Outputs Parse

#### Bad Antipattern (AI Common Hallucination)
> **Why it fails**: Unconstrained generation produces schema mismatches and missing required attributes.
```python
# ANTI-PATTERN: Calling json.loads on completion text in Python
resp = client.chat.completions.create(model='gpt-4o', messages=[...])
data = json.loads(resp.choices[0].message.content)
```

#### Production Standard (Correct)
> **Standard**: Natively generates Pydantic models with compiler-enforced field constraints and automatic type conversion.
```python
# PRODUCTION STANDARD: OpenAI Python SDK beta.chat.completions.parse
from pydantic import BaseModel, Field
from openai import OpenAI

class ExtractedEntity(BaseModel):
    entity_name: str
    category: str = Field(description='organization, person, or location')
    confidence_score: float

client = OpenAI()
completion = client.beta.chat.completions.parse(
    model='gpt-4o',
    messages=[{'role': 'user', 'content': 'Acme Corp acquired Contoso in London.'}],
    response_format=ExtractedEntity,
)
entity = completion.choices[0].message.parsed
```
Recommended MCP Servers (mcp-serverlist.com)

Equip agent with system tools to verify code for this stack.

OpenAI Gateway MCP
Inspect and validate OpenAI Structured Outputs token constraints and schemas.
Recommended Agent Skills (askills.dev)

Ready-to-use executable skill functions tailored to this stack.

Zod Structured Output Schema Builder
Generate strict Zod schemas and Pydantic models for OpenAI Structured Outputs.
Architectural Specification & Invariant Rationale

Architectural Invariant Design: OpenAI Structured Outputs & Zod Strict JSON Schema Enforcement

OpenAI Structured Outputs & Zod Strict JSON Schema Enforcement defines an industrial-grade behavioral standard for backend engineering. Production standard for deterministic LLM tool calling and structured outputs. Mandates native response_format: zodResponseFormat with strict: true, eliminates flaky regex markdown code-block parsing, and guarantees 100% schema compliance. Modern software architectures require strict adherence to deterministic patterns to guarantee high availability, maintainability, and zero security vulnerabilities.

Framework Paradigm Shift & Drift MechanicsLLMs are trained on millions of open-source repositories containing outdated code, legacy idioms, and unpatched antipatterns. When coding assistants generate implementations for this stack, they default to common statistical tokens: AI writes brittle regex to strip ```json code fences from LLM text responses, crashing on omitted fields. Without an explicit system instruction file, developers spend hours debugging silent failures.
Failure Modes & Production Blast Radius

Hazard Analysis: What Breaks Without This Rule

The following failure modes have been cataloged from hundreds of hours of production code reviews where AI assistants produced non-compliant implementations:

Failure ModeAI Symptom (The Anti-Pattern)SeverityProduction Impact & Remedy
AI Hallucination & Deprecation DriftAI writes brittle regex to strip ```json code fences from LLM text responses, crashing on omitted fields.Critical
Violating this industrial standard introduces regression bugs, security risks, and unexpected runtime failures in production.
Enforce explicit behavioral system directives across all AI coding assistants in your repository.
Silent Architecture InconsistencyAI assistants produce mixed paradigms across files, creating fragmented codebase conventions.Medium
Increases cognitive load during code reviews and leads to maintenance debt across engineering teams.
Pin project conventions in .cursor/rules, CLAUDE.md, and AGENTS.md so all team agents follow identical guardrails.
Architectural Directives in Detail

Step-by-Step Production Directives

Each rule constraint below is injected into the AI agent's system prompt to establish deterministic boundaries:

1

Always use openai.beta.chat.completions.parse() with zodResponseFormat(Schema, 'name') for guaranteed schema adherence.

Always use openai.beta.chat.completions.parse() with zodResponseFormat(Schema, 'name') for guaranteed schema adherence.

Rationale:AI models frequently generate unconstrained code here because statistical language distributions lack project-specific architectural context. Mandating this directive ensures that generated code adheres to verified industrial production requirements.
Enforcement:Integrated into the Agent Pack rule file. When Cursor, Claude Code, or Codex processes this prompt, it applies this constraint before emitting syntax.
2

Ensure all Zod schema fields are explicitly marked or nullable

Ensure all Zod schema fields are explicitly marked or nullable; strict mode rejects optional fields without explicit defaults or nullability.

Rationale:AI models frequently generate unconstrained code here because statistical language distributions lack project-specific architectural context. Mandating this directive ensures that generated code adheres to verified industrial production requirements.
Enforcement:Integrated into the Agent Pack rule file. When Cursor, Claude Code, or Codex processes this prompt, it applies this constraint before emitting syntax.
3

Check completion.choices[0].message.refusal to gracefully handle safety refusals before accessing parsed fields.

Check completion.choices[0].message.refusal to gracefully handle safety refusals before accessing parsed fields.

Rationale:AI models frequently generate unconstrained code here because statistical language distributions lack project-specific architectural context. Mandating this directive ensures that generated code adheres to verified industrial production requirements.
Enforcement:Integrated into the Agent Pack rule file. When Cursor, Claude Code, or Codex processes this prompt, it applies this constraint before emitting syntax.
4

Never perform manual regex stripping of '```json' or JSON.parse on unstructured message.content.

Never perform manual regex stripping of '```json' or JSON.parse on unstructured message.content.

Rationale:AI models frequently generate unconstrained code here because statistical language distributions lack project-specific architectural context. Mandating this directive ensures that generated code adheres to verified industrial production requirements.
Enforcement:Integrated into the Agent Pack rule file. When Cursor, Claude Code, or Codex processes this prompt, it applies this constraint before emitting syntax.
Technical Questions & Answers

Frequently Asked Technical Questions

Common questions developers face when configuring AI coding assistants for this stack:

Q:Why is OpenAI Structured Outputs & Zod Strict JSON Schema Enforcement critical for AI coding assistants?

Production standard for deterministic LLM tool calling and structured outputs. Mandates native response_format: zodResponseFormat with strict: true, eliminates flaky regex markdown code-block parsing, and guarantees 100% schema compliance. Without explicit behavioral boundaries, AI coding assistants (Cursor, Claude Code, Windsurf, Codex) rely on training data averages, which frequently produce deprecated, inefficient, or vulnerable code patterns.

Q:How does adopting this rule prevent AI hallucinations?

This rule explicitly declares what the AI must avoid (AI writes brittle regex to strip ```json code fences from LLM text responses, crashing on omitted fields.) and prescribes verified positive examples. Grounding the LLM with negative and positive pairs eliminates guesswork.

Q:Which AI coding environments are supported?

This specification is multi-platform compatible: Cursor (.cursor/rules/*.mdc & .cursorrules), Anthropic Claude Code (CLAUDE.md), Windsurf (.windsurfrules), Codex / Cline (AGENTS.md), and GitHub Copilot (.github/copilot-instructions.md).

Q:Can I combine this rule with other technology stacks?

Yes. Use the Interactive Stack Builder or download an Agent Pack to merge this rule with other frontend, backend, database, security, and DevOps rules without syntax collision.

Open Specification · CC BY 4.0·Free for Personal, Team & Commercial In-Repo Use

Citation & Open Source Attribution Guidelines

This specification is licensed under Creative Commons Attribution 4.0 International (CC BY 4.0). You are completely free to adapt and share this rule in your workspace. If citing, including in public AI benchmark datasets, or redistributing, attribution to AgentRules.org is required.

Related BACKEND Rules

View all rules →
backend
42

Fastify 5 Schema Compilers & Encapsulation Production Standard

Fastify relies on lexical encapsulation contexts to sandbox decorators, hooks, and compiled validation/serialization schemas without memory leaks or cross-tenant bleed. In Fastify 5, misuse of global compilers or failing to encapsulate plugin boundaries causes compiled `fast-json-stringify` serializers and Ajv validators to either crash on duplicate IDs, leak private data across sibling scopes, or bypass JIT compilation optimizations. Production services must enforce strict encapsulation hierarchies and type-safe schema compilation across every routing subtree.

backend
68

Bun Embedded SQLite WAL Mode & Transaction Synchronization Standard

Production database standard for bun:sqlite. Mandates enabling Write-Ahead Logging (PRAGMA journal_mode = WAL), busy timeouts, and using db.transaction() for atomic operations without lock starvation.

backend
68

Drizzle ORM Batch API & Interactive Transaction Isolation Standard

Production database standard for Drizzle ORM (PostgreSQL & MySQL). Mandates using db.batch() over HTTP drivers to prevent round-trip waterfalls, explicit db.transaction() with serializable/read-committed isolation, and strictly avoids unawaited query promises.

1 Rule in Stack

OpenAI