explain_code
Generate human-readable code explanations, tutorials, and architectural insights from GitHub repositories using AI. Tailor explanations by type, audience, and focus for clear understanding.
Instructions
📚 AI-powered code explanation generating human-readable documentation, tutorials, and architectural insights. Transforms technical analysis into accessible explanations.
Input Schema
Name | Required | Description | Default |
---|---|---|---|
explanation_type | No | Type of explanation to generate | overview |
file_paths | No | Specific files to explain (optional - explains key files if not specified) | |
options | No | ||
url | Yes | GitHub repository URL |
Input Schema (JSON Schema)
{
"properties": {
"explanation_type": {
"default": "overview",
"description": "Type of explanation to generate",
"enum": [
"overview",
"detailed",
"architecture",
"tutorial",
"integration"
],
"type": "string"
},
"file_paths": {
"description": "Specific files to explain (optional - explains key files if not specified)",
"items": {
"type": "string"
},
"type": "array"
},
"options": {
"properties": {
"ai_model": {
"default": "auto",
"description": "AI model to use for explanation (OpenRouter models). Use \"auto\" for intelligent model selection",
"type": "string"
},
"focus_on_patterns": {
"default": true,
"description": "Focus on design patterns and architecture",
"type": "boolean"
},
"include_diagrams": {
"default": true,
"description": "Include ASCII diagrams where helpful",
"type": "boolean"
},
"include_examples": {
"default": true,
"description": "Include code examples in explanations",
"type": "boolean"
},
"target_audience": {
"default": "intermediate",
"description": "Target audience for explanation",
"enum": [
"beginner",
"intermediate",
"advanced"
],
"type": "string"
}
},
"type": "object"
},
"url": {
"description": "GitHub repository URL",
"type": "string"
}
},
"required": [
"url"
],
"type": "object"
}