AI Developer Guide API

JSON API providing standards, patterns and principles for effective AI-assisted development. This API is used by the MCP server to connect LLMs to the guide.

Quickstart

Add this JSON structure to your AI assistant (Claude Desktop, Cursor, VS Code, etc.):

{
  "mcpServers": {
    "ai-developer-guide": {
      "command": "npx",
      "args": ["@dwmkerr/ai-developer-guide-mcp"]
    }
  }
}

See the MCP documentation for detailed setup instructions (Claude, Cursor, VS Code, etc.) →

Example prompt: "Review my Python code and suggest improvements following best practices"

Test with MCP Inspector:
npx @modelcontextprotocol/inspector npx @dwmkerr/ai-developer-guide-mcp

About This API

This JSON API serves the AI Developer Guide content in a structured format that can be consumed by Large Language Models (LLMs) through the Model Context Protocol (MCP) server.

Core Features

Main Guide: Complete development methodology with Plan/Implement/Review approach
Language-Specific Guides: Best practices for Python, Shell Scripts, and more
Pattern Guides: Reusable patterns like Makefiles and project structure
Platform Guides: Database and infrastructure-specific recommendations

API Info

Base URL: Current domain
Format: JSON
Version: 0.1.12
Updated: 2025-06-26

Available Guides

Type	Guide	Endpoint
Main	AI Developer Guide	`api/guide.json`
Language	Python	`api/guides/languages/python.json`
Language	Shell Scripts	`api/guides/languages/shell-scripts.json`
Pattern	CI/CD	`api/guides/patterns/cicd.json`
Pattern	CLIs (Command Line Applications)	`api/guides/patterns/clis.json`
Pattern	Documentation	`api/guides/patterns/documentation.json`
Pattern	Makefiles	`api/guides/patterns/make.json`
Pattern	Open Source	`api/guides/patterns/open-source.json`
Platform	PostgreSQL	`api/guides/platforms/postgresql.json`
Other	Contributors	`api/guides/others/contributors.json`
Other	Kubernetes Development	`api/guides/others/kubernetes-development.json`