designpattern.fyi Developer Resources

Official developer APIs, OpenAPI 3.1.0 specification, Model Context Protocol (MCP) server schemas, and machine-readable data feeds for designpattern.fyi.

🔌 API Endpoints

OpenAPI 3.1.0 Specification

Complete API documentation with all endpoints, schemas, and examples.

/api/openapi.json

Patterns Catalog API

Complete catalog of 723+ software design patterns in JSON format.

/api/v1/patterns.json

Categories API

Category taxonomies and subcategory metadata.

/api/v1/categories.json

Skills API

AI agent skill specifications for tool integration.

/api/v1/skills.json

MCP Schema API

Model Context Protocol tool schema for agent integration.

/api/v1/mcp-schema.json

Error Schema API

Canonical error response schema for API error handling.

/api/v1/error.json

📄 Machine-Readable Documentation

llms.txt

Standard LLM guidance for agents and coding assistants.

/llms.txt

llms-full.txt

Full LLM context with detailed instructions and examples.

/llms-full.txt

Agent Instructions

Specific instructions for AI agents referencing designpattern.fyi.

/agent-instructions.txt

AGENTS.md

Agent calling instructions and when-to-use guidelines.

/AGENTS.md

🔄 Protocols & Standards

Open Knowledge Format (OKF)

Knowledge packaging format for AI agents and cognitive systems.

/okf/

Agentic Resource Discovery (ARD)

Resource discovery protocol for autonomous agent systems.

/ard/

🔒 Rate Limiting

All API endpoints include rate limit headers:

  • RateLimit-Limit: 1000 - Requests per hour
  • RateLimit-Remaining: <remaining> - Remaining requests
  • RateLimit-Reset: <unix_timestamp> - Reset timestamp
  • RateLimit-Window: 3600 - Window in seconds (1 hour)
  • Retry-After: 60 - Seconds to wait on 429 responses

🤖 Agent Integration

designpattern.fyi is optimized for AI agent integration with:

  • Structured JSON responses for all data endpoints
  • Machine-readable error responses with resolution hints
  • Agent-friendly 404 responses with recovery guidance
  • Markdown content negotiation (Accept: text/markdown)
  • Standard LLM guidance files (llms.txt, agent-instructions.txt)
  • OpenAPI 3.1.0 specification for automatic client generation
  • MCP schema for Model Context Protocol integration