Skip to content

Pull

pull

GitPullTool — pull a remote branch into the local repository.

GitPullTool

Bases: AXMTool

Pull a remote branch (default origin main) into the local repo.

Registered as git_pull via axm.tools entry point.

Source code in packages/axm-git/src/axm_git/tools/pull.py
Python
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
class GitPullTool(AXMTool):
    """Pull a remote branch (default ``origin main``) into the local repo.

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

    domain = "git"
    tags = frozenset({"pull", "sync", "remote"})

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

    def execute(
        self,
        *,
        branch: str = "main",
        remote: str = "origin",
        path: str = ".",
        **kwargs: object,
    ) -> ToolResult:
        """Pull *remote*/*branch* into the local repository.

        Args:
            branch: Remote branch to pull (default ``main``).
            remote: Remote name (default ``origin``).
            path: Repository path.

        Returns:
            ToolResult with ``pulled``, ``remote`` and ``branch`` on success.
        """
        resolved = Path(path).resolve()
        try:
            check = run_git(["rev-parse", "--git-dir"], resolved)
            if check.returncode != 0:
                repo_err = not_a_repo_error(check.stderr, resolved)
                return ToolResult(
                    success=repo_err.success,
                    error=repo_err.error,
                    data=repo_err.data,
                    text=render_failure_text(error=repo_err.error or ""),
                )

            result = run_git(["pull", remote, branch], resolved)
            if result.returncode != 0:
                error = result.stderr.strip() or result.stdout.strip()
                return ToolResult(
                    success=False,
                    error=f"git pull failed: {error}",
                    text=render_failure_text(error=error),
                )
        except subprocess.TimeoutExpired as exc:
            return timeout_error_result(exc)

        data: dict[str, object] = {
            "pulled": True,
            "remote": remote,
            "branch": branch,
        }
        return ToolResult(success=True, data=data, text=render_text(data))
name property

Tool name used for MCP registration.

execute(*, branch='main', remote='origin', path='.', **kwargs)

Pull remote/branch into the local repository.

Parameters:

Name Type Description Default
branch str

Remote branch to pull (default main).

 'main'
remote str

Remote name (default origin).

 'origin'
path str

Repository path.

 '.'

Returns:

Type Description
ToolResult

ToolResult with pulled, remote and branch on success.
Source code in packages/axm-git/src/axm_git/tools/pull.py
Python
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
def execute(
    self,
    *,
    branch: str = "main",
    remote: str = "origin",
    path: str = ".",
    **kwargs: object,
) -> ToolResult:
    """Pull *remote*/*branch* into the local repository.

    Args:
        branch: Remote branch to pull (default ``main``).
        remote: Remote name (default ``origin``).
        path: Repository path.

    Returns:
        ToolResult with ``pulled``, ``remote`` and ``branch`` on success.
    """
    resolved = Path(path).resolve()
    try:
        check = run_git(["rev-parse", "--git-dir"], resolved)
        if check.returncode != 0:
            repo_err = not_a_repo_error(check.stderr, resolved)
            return ToolResult(
                success=repo_err.success,
                error=repo_err.error,
                data=repo_err.data,
                text=render_failure_text(error=repo_err.error or ""),
            )

        result = run_git(["pull", remote, branch], resolved)
        if result.returncode != 0:
            error = result.stderr.strip() or result.stdout.strip()
            return ToolResult(
                success=False,
                error=f"git pull failed: {error}",
                text=render_failure_text(error=error),
            )
    except subprocess.TimeoutExpired as exc:
        return timeout_error_result(exc)

    data: dict[str, object] = {
        "pulled": True,
        "remote": remote,
        "branch": branch,
    }
    return ToolResult(success=True, data=data, text=render_text(data))