Skip to content

Check

check

InitCheckTool — project conformity check as an AXMTool.

InitCheckTool

Check a project against the AXM gold standard.

Registered as init_check via axm.tools entry point.

Source code in packages/axm-init/src/axm_init/tools/check.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
class InitCheckTool:
    """Check a project against the AXM gold standard.

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

    @property
    def name(self) -> str:
        """Tool name used for MCP registration."""
        return "init_check"

    def execute(self, **kwargs: Any) -> ToolResult:
        """Check a project against the AXM gold standard.

        Args:
            **kwargs: Keyword arguments.
                path: Path to project root.
                category: Optional category filter.

        Returns:
            ToolResult with check scores and details.
        """
        path: str = kwargs.get("path", ".")
        category: str | None = kwargs.get("category")
        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_init.core.checker import CheckEngine, format_agent

            engine = CheckEngine(project_path, category=category)
            result = engine.run()
            return ToolResult(success=True, data=format_agent(result))
        except Exception as exc:
            return ToolResult(success=False, error=str(exc))
name property

Tool name used for MCP registration.

execute(**kwargs)

Check a project against the AXM gold standard.

Parameters:

Name Type Description Default
**kwargs Any

Keyword arguments. path: Path to project root. category: Optional category filter.

 {}

Returns:

Type Description
ToolResult

ToolResult with check scores and details.
Source code in packages/axm-init/src/axm_init/tools/check.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
def execute(self, **kwargs: Any) -> ToolResult:
    """Check a project against the AXM gold standard.

    Args:
        **kwargs: Keyword arguments.
            path: Path to project root.
            category: Optional category filter.

    Returns:
        ToolResult with check scores and details.
    """
    path: str = kwargs.get("path", ".")
    category: str | None = kwargs.get("category")
    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_init.core.checker import CheckEngine, format_agent

        engine = CheckEngine(project_path, category=category)
        result = engine.run()
        return ToolResult(success=True, data=format_agent(result))
    except Exception as exc:
        return ToolResult(success=False, error=str(exc))