Skip to content

Tools

tools

AXMTool surface over the config doctor.

:class:ConfigDoctorTool is the deterministic config_doctor tool: it wraps :func:axm_config.doctor.config_doctor_data and shapes the result as a :class:~axm.tools.base.ToolResult. All business logic lives in the central function; this module only adds the MCP/CLI boundary (success/error shaping), so CLI and MCP share the exact same provenance computation.

ConfigDoctorTool

Report config-key provenance (env/file/default), read-only.

Satisfies the :class:~axm.tools.base.AXMTool protocol structurally. The tool is diagnostic: it never mutates any config layer, it only reports which layer would win per key.

Source code in packages/axm-config/src/axm_config/tools.py
Python
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
class ConfigDoctorTool:
    """Report config-key provenance (``env``/``file``/``default``), read-only.

    Satisfies the :class:`~axm.tools.base.AXMTool` protocol structurally. The
    tool is diagnostic: it never mutates any config layer, it only reports
    which layer would win per key.
    """

    agent_hint = (
        "Report where each config key resolves from (env>file>default) for a "
        "namespace; read-only provenance, never mutates. Replaces manual "
        "~/.axm TOML + env inspection."
    )
    domain = "config"
    tags = frozenset({"config", "provenance", "doctor"})

    @property
    def name(self) -> str:
        """Unique tool identifier."""
        return "config_doctor"

    def execute(self, *, namespace: str | None = None) -> ToolResult:
        """Return the provenance report for ``namespace`` (or all known).

        On success, ``data`` is the ``{"<ns>.<key>": {layer, present}}``
        mapping from :func:`config_doctor_data`. Any failure is shaped into
        ``ToolResult(success=False, error=...)`` at the MCP boundary.
        """
        try:
            report = config_doctor_data(namespace)
        except Exception as exc:  # noqa: BLE001 - MCP boundary
            return ToolResult(success=False, error=str(exc))
        return ToolResult(success=True, data=report)
name property

Unique tool identifier.

execute(*, namespace=None)

Return the provenance report for namespace (or all known).

On success, data is the {"<ns>.<key>": {layer, present}} mapping from :func:config_doctor_data. Any failure is shaped into ToolResult(success=False, error=...) at the MCP boundary.

Source code in packages/axm-config/src/axm_config/tools.py
Python
40
41
42
43
44
45
46
47
48
49
50
51
def execute(self, *, namespace: str | None = None) -> ToolResult:
    """Return the provenance report for ``namespace`` (or all known).

    On success, ``data`` is the ``{"<ns>.<key>": {layer, present}}``
    mapping from :func:`config_doctor_data`. Any failure is shaped into
    ``ToolResult(success=False, error=...)`` at the MCP boundary.
    """
    try:
        report = config_doctor_data(namespace)
    except Exception as exc:  # noqa: BLE001 - MCP boundary
        return ToolResult(success=False, error=str(exc))
    return ToolResult(success=True, data=report)