Skip to content

Doc impact

doc_impact

MCP tool wrapper for doc impact analysis.

DocImpactTool

Bases: AXMTool

Analyze documentation impact for symbols.

Registered as ast_doc_impact via axm.tools entry point.

Caveat — the matching is purely lexical, never semantic: a symbol counts as mentioned when its bare name appears between backticks or in a Markdown heading, and a bare name-drop anywhere in the prose is enough to clear it from undocumented. Read the output as a list of pages to read, not a proof that the documentation is correct or up to date.

Source code in packages/axm-ast/src/axm_ast/tools/doc_impact.py
Python
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
class DocImpactTool(AXMTool):
    """Analyze documentation impact for symbols.

    Registered as ``ast_doc_impact`` via axm.tools entry point.

    Caveat — the matching is purely lexical, never semantic: a symbol counts
    as mentioned when its bare name appears between backticks or in a
    Markdown heading, and a bare name-drop anywhere in the prose is enough
    to clear it from ``undocumented``. Read the output as a list of
    pages to read, not a proof that the documentation is correct or up
    to date.
    """

    @property
    def name(self) -> str:
        """Return tool name for registry lookup."""
        return "ast_doc_impact"

    @safe_execute
    def execute(
        self,
        *,
        path: str = ".",
        symbols: list[str] | None = None,
        **kwargs: object,
    ) -> ToolResult:
        """Analyze doc impact for symbols.

        Caveat — the matching is purely lexical, never semantic: a symbol
        counts as mentioned when its bare name appears between backticks or
        in a Markdown heading, and a bare name-drop anywhere in the prose is
        enough to clear it from ``undocumented``. Read the output as a list
        of pages to read, not a proof that the documentation is correct or
        up to date.

        Args:
            path: Project root directory.
            symbols: Symbol names to analyze.
            **kwargs: Reserved for future use.

        Returns:
            ToolResult with doc impact data.
        """
        if not symbols:
            return ToolResult(success=False, error="symbols parameter is required")

        project_path = Path(path).resolve()
        if not project_path.is_dir():
            return ToolResult(success=False, error=f"Not a directory: {project_path}")

        from axm_ast.core.doc_impact import analyze_doc_impact

        try:
            result: DocImpactResult = analyze_doc_impact(project_path, symbols)
        except Exception as exc:  # noqa: BLE001
            return ToolResult(success=False, error=str(exc))

        from axm_ast.tools.doc_impact_text import (
            DocImpactResult as DocImpactTextResult,
        )
        from axm_ast.tools.doc_impact_text import render_doc_impact_text

        text = (
            render_doc_impact_text(cast("DocImpactTextResult", result))
            if isinstance(result, dict)
            else None
        )
        return ToolResult(
            success=True,
            data=cast("dict[str, object]", result),
            text=text,
        )
name property

Return tool name for registry lookup.

execute(*, path='.', symbols=None, **kwargs)

Analyze doc impact for symbols.

Caveat — the matching is purely lexical, never semantic: a symbol counts as mentioned when its bare name appears between backticks or in a Markdown heading, and a bare name-drop anywhere in the prose is enough to clear it from undocumented. Read the output as a list of pages to read, not a proof that the documentation is correct or up to date.

Parameters:

Name Type Description Default
path str

Project root directory.

 '.'
symbols list[str] | None

Symbol names to analyze.

 None
**kwargs object

Reserved for future use.

 {}

Returns:

Type Description
ToolResult

ToolResult with doc impact data.
Source code in packages/axm-ast/src/axm_ast/tools/doc_impact.py
Python
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
@safe_execute
def execute(
    self,
    *,
    path: str = ".",
    symbols: list[str] | None = None,
    **kwargs: object,
) -> ToolResult:
    """Analyze doc impact for symbols.

    Caveat — the matching is purely lexical, never semantic: a symbol
    counts as mentioned when its bare name appears between backticks or
    in a Markdown heading, and a bare name-drop anywhere in the prose is
    enough to clear it from ``undocumented``. Read the output as a list
    of pages to read, not a proof that the documentation is correct or
    up to date.

    Args:
        path: Project root directory.
        symbols: Symbol names to analyze.
        **kwargs: Reserved for future use.

    Returns:
        ToolResult with doc impact data.
    """
    if not symbols:
        return ToolResult(success=False, error="symbols parameter is required")

    project_path = Path(path).resolve()
    if not project_path.is_dir():
        return ToolResult(success=False, error=f"Not a directory: {project_path}")

    from axm_ast.core.doc_impact import analyze_doc_impact

    try:
        result: DocImpactResult = analyze_doc_impact(project_path, symbols)
    except Exception as exc:  # noqa: BLE001
        return ToolResult(success=False, error=str(exc))

    from axm_ast.tools.doc_impact_text import (
        DocImpactResult as DocImpactTextResult,
    )
    from axm_ast.tools.doc_impact_text import render_doc_impact_text

    text = (
        render_doc_impact_text(cast("DocImpactTextResult", result))
        if isinstance(result, dict)
        else None
    )
    return ToolResult(
        success=True,
        data=cast("dict[str, object]", result),
        text=text,
    )