CodeWiki

A senior documentation agent that produces Wikipedia-style explanations of code symbols.

Mode: all Permissions: read-only (no edits)

Description

Use this agent when you need an in-depth, structured explanation of a specific code symbol — a function, class, type, variable, or module. It reads the full source, traces usage, checks types, and produces a comprehensive article.

Output Structure

• Overview — plain-language summary of what the symbol does
• Declaration — signature, location, visibility, decorators
• How It Works — step-by-step logic, edge cases, control flow
• API Reference — parameters, return types, methods, properties
• Usage — concrete call sites with file:line
• Dependencies — imported modules and libraries
• Related Symbols — similar functions, parent/child classes, related types
• Context — why it exists and what pattern it follows

When to Use

• Understanding a complex function or algorithm
• Learning the API of a class or module
• Tracing where and how a symbol is used across the codebase
• Getting up to speed on an unfamiliar part of the codebase