Skip to content

Context

context

ContextTool — one-shot project context dump.

ContextTool

Bases: AXMTool

One-shot project context: stack, patterns, module ranking.

Registered as ast_context via axm.tools entry point. Workspace-aware: if path is a uv workspace root, returns workspace-level context with all packages.

Source code in packages/axm-ast/src/axm_ast/tools/context.py 
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
class ContextTool(AXMTool):
    """One-shot project context: stack, patterns, module ranking.

    Registered as ``ast_context`` via axm.tools entry point.
    Workspace-aware: if path is a uv workspace root, returns
    workspace-level context with all packages.
    """

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

    def execute(
        self, *, path: str = ".", depth: int = 1, slim: bool = False, **kwargs: Any
    ) -> ToolResult:
        """Dump complete project context for AI agents.

        Args:
            path: Path to package or workspace directory.
            depth: Detail level (0=top-5, 1=sub-packages,
                2=modules, 3+=symbols, None=full).
            slim: If True, override depth to 0 for compact output.

        Returns:
            ToolResult with project context data.
        """
        if slim:
            depth = 0
        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.workspace import detect_workspace

            ws = detect_workspace(project_path)
            if ws is not None:
                from axm_ast.core.workspace import build_workspace_context

                ctx = build_workspace_context(project_path)
                return ToolResult(
                    success=True,
                    data=ctx,
                    hint=(
                        "Tip: Use ast_describe(modules=[...])"
                        " to see specific module APIs."
                    ),
                )

            from axm_ast.core.context import build_context, format_context_json

            ctx = build_context(project_path)
            return ToolResult(
                success=True,
                data=format_context_json(ctx, depth=depth),
                hint=(
                    "Tip: Use ast_describe(modules=[...]) to see specific module APIs."
                ),
            )
        except Exception as exc:
            return ToolResult(success=False, error=str(exc))
name property

Return tool name for registry lookup.

execute(*, path='.', depth=1, slim=False, **kwargs)

Dump complete project context for AI agents.

Parameters:

Name Type Description Default
path str

Path to package or workspace directory.

 '.'
depth int

Detail level (0=top-5, 1=sub-packages, 2=modules, 3+=symbols, None=full).

 1
slim bool

If True, override depth to 0 for compact output.

 False

Returns:

Type Description
ToolResult

ToolResult with project context data.
Source code in packages/axm-ast/src/axm_ast/tools/context.py 
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
def execute(
    self, *, path: str = ".", depth: int = 1, slim: bool = False, **kwargs: Any
) -> ToolResult:
    """Dump complete project context for AI agents.

    Args:
        path: Path to package or workspace directory.
        depth: Detail level (0=top-5, 1=sub-packages,
            2=modules, 3+=symbols, None=full).
        slim: If True, override depth to 0 for compact output.

    Returns:
        ToolResult with project context data.
    """
    if slim:
        depth = 0
    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.workspace import detect_workspace

        ws = detect_workspace(project_path)
        if ws is not None:
            from axm_ast.core.workspace import build_workspace_context

            ctx = build_workspace_context(project_path)
            return ToolResult(
                success=True,
                data=ctx,
                hint=(
                    "Tip: Use ast_describe(modules=[...])"
                    " to see specific module APIs."
                ),
            )

        from axm_ast.core.context import build_context, format_context_json

        ctx = build_context(project_path)
        return ToolResult(
            success=True,
            data=format_context_json(ctx, depth=depth),
            hint=(
                "Tip: Use ast_describe(modules=[...]) to see specific module APIs."
            ),
        )
    except Exception as exc:
        return ToolResult(success=False, error=str(exc))