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.

Source code in packages/axm-ast/src/axm_ast/tools/doc_impact.py 
13
14
15
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
class DocImpactTool(AXMTool):
    """Analyze documentation impact for symbols.

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

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

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

        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")

        try:
            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

            result = analyze_doc_impact(project_path, symbols)
            return ToolResult(success=True, data=result)
        except Exception as exc:
            return ToolResult(success=False, error=str(exc))
name property

Return tool name for registry lookup.

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

Analyze doc impact for symbols.

Parameters:

Name Type Description Default
path str

Project root directory.

 '.'
symbols list[str] | None

Symbol names to analyze.

 None
**kwargs Any

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 
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
def execute(
    self,
    *,
    path: str = ".",
    symbols: list[str] | None = None,
    **kwargs: Any,
) -> ToolResult:
    """Analyze doc impact for symbols.

    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")

    try:
        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

        result = analyze_doc_impact(project_path, symbols)
        return ToolResult(success=True, data=result)
    except Exception as exc:
        return ToolResult(success=False, error=str(exc))