explain
Explain a specific code node by ID, revealing its purpose, source location, callers, and callees in a markdown summary. Ideal for understanding a function's role and context without reading full source.
Instructions
Return a natural-language explanation of a code node.
Given a node ID (e.g., meth:Sources/Networking/Client.swift:HTTPClient.send),
returns a markdown-formatted explanation that includes:
What it is: The node's kind, short description from its doc-comment
Where it lives: Module path and source location
What calls it: The callers (reverse call graph)
What it calls: The callees (functions/methods this node invokes)
Documentation: Full doc-comment if available
This is ideal for understanding the role and context of a specific node
without needing to read the full source code. Use pack_snippets()
to then retrieve the actual implementation.
:param node_id: Stable node identifier, e.g.
meth:Sources/Networking/Client.swift:HTTPClient.send.
:param limit: Maximum callers and callees to list (default 10). Pass 0
to list all.
:return: Markdown-formatted explanation ready for LLM consumption.
Input Schema
| Name | Required | Description | Default |
|---|---|---|---|
| limit | No | ||
| node_id | Yes |
Output Schema
| Name | Required | Description | Default |
|---|---|---|---|
| result | Yes |