Skip to content

Clone

clone

GitCloneTool — clone a remote or local git repository.

GitCloneTool

Bases: AXMTool

Clone a git repository into a local directory.

Registered as git_clone via axm.tools entry point.

Source code in packages/axm-git/src/axm_git/tools/clone.py
Python
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
57
58
59
60
61
62
63
64
65
66
67
class GitCloneTool(AXMTool):
    """Clone a git repository into a local directory.

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

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

    def execute(  # type: ignore[override]
        self,
        *,
        url: str,
        dest: str,
        path: str = ".",
        **kwargs: object,
    ) -> ToolResult:
        """Clone *url* into *dest* relative to *path*.

        Args:
            url: Repository URL or local path to clone from.
            dest: Destination directory name (relative to *path*).
            path: Parent directory in which to create the clone
                (default: current working directory).

        Returns:
            ToolResult with url, dest, absolute clone path, and
            ``cloned: True`` on success.
        """
        cwd = Path(path).resolve()

        try:
            # Clone can be slow over a network — use timeout=None so large
            # repos are not killed mid-transfer.  Local clones are fast;
            # callers that need a hard limit can wrap this tool themselves.
            result = run_git(["clone", url, dest], cwd, timeout=None)
        except subprocess.TimeoutExpired as exc:
            return timeout_error_result(exc)

        if result.returncode != 0:
            return ToolResult(success=False, error=result.stderr.strip())

        return ToolResult(
            success=True,
            data={
                "url": url,
                "dest": dest,
                "path": str(cwd / dest),
                "cloned": True,
            },
        )
name property

Tool name used for MCP registration.

execute(*, url, dest, path='.', **kwargs)

Clone url into dest relative to path.

Parameters:

Name Type Description Default
url str

Repository URL or local path to clone from.

 required
dest str

Destination directory name (relative to path).

 required
path str

Parent directory in which to create the clone (default: current working directory).

 '.'

Returns:

Type Description
ToolResult

ToolResult with url, dest, absolute clone path, and
ToolResult

cloned: True on success.
Source code in packages/axm-git/src/axm_git/tools/clone.py
Python
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
def execute(  # type: ignore[override]
    self,
    *,
    url: str,
    dest: str,
    path: str = ".",
    **kwargs: object,
) -> ToolResult:
    """Clone *url* into *dest* relative to *path*.

    Args:
        url: Repository URL or local path to clone from.
        dest: Destination directory name (relative to *path*).
        path: Parent directory in which to create the clone
            (default: current working directory).

    Returns:
        ToolResult with url, dest, absolute clone path, and
        ``cloned: True`` on success.
    """
    cwd = Path(path).resolve()

    try:
        # Clone can be slow over a network — use timeout=None so large
        # repos are not killed mid-transfer.  Local clones are fast;
        # callers that need a hard limit can wrap this tool themselves.
        result = run_git(["clone", url, dest], cwd, timeout=None)
    except subprocess.TimeoutExpired as exc:
        return timeout_error_result(exc)

    if result.returncode != 0:
        return ToolResult(success=False, error=result.stderr.strip())

    return ToolResult(
        success=True,
        data={
            "url": url,
            "dest": dest,
            "path": str(cwd / dest),
            "cloned": True,
        },
    )