pathgate 0.2.0__tar.gz → 0.2.2__tar.gz

{pathgate-0.2.0 → pathgate-0.2.2}/PKG-INFO

@@ -1,6 +1,6 @@
 Metadata-Version: 2.5
 Name: pathgate
-Version: 0.2.0
+Version: 0.2.2
 Summary: Filesystem MCP server with allow-listed directories
 License: MIT
 License-File: LICENSE
@@ -8,7 +8,7 @@ Requires-Python: >=3.10
 Requires-Dist: mcp<3,>=2
 Description-Content-Type: text/markdown
 
-# Pathgate
+# Pathgate 
 
 `pathgate` is a Python Model Context Protocol (MCP) server that exposes a controlled filesystem interface to MCP clients such as Claude Desktop, Cursor, VS Code, and inspector tools. The server only permits access to directories that are explicitly allow-listed at startup.
 
@@ -31,13 +31,40 @@ Access is restricted by allow-listed paths. At startup, the server resolves the
 
 ## Installation
 
+Pathgate package is published on PyPI. To use it, for example with Claude Desktop, add this in the 
+
+```json
+{
+  "mcpServers": {
+    "pathgate": {
+      "command": "uvx",
+      "args": ["pathgate", "C:\\Users\\me\\Documents"]
+    }
+  }
+}
+```
+
+Or, you can use the install command to directly write the config file
+
 ```bash
-git clone https://github.com/geekgod382/pathgate.git
-cd pathgate
-python -m pip install -e .
+uvx pathgate install <paths>
 ```
 
-This installs the `pathgate` console command from `pyproject.toml`.
+paths should have nothing between them
+
+```bash
+uvx pathgate install C:\Users\me\Documents C:\Users\me\Projects
+```
+
+When no paths are given, it prompts you for them.
+
+### Options
+
+`--read-only:` writes the safer variant of the entry.
+`--dry-run`: shows what it would write and changes nothing.
+`--yes`: skips the confirmation prompt.
+`--name`: sets a different entry name (default pathgate).
+`--config PATH`: I build this mcp server for Claude primarily. Using this option edits a specific file, which also works for other clients that use the same mcpServers shape.
 
 ## Usage
 
@@ -77,20 +104,6 @@ The current implementation exposes these tools:
 - `search_files_tool` — search for files matching a pattern
 - `get_file_info_tool` — return metadata for a file or directory
 
-## MCP client configuration
-
-Example Claude Desktop configuration:
-
-```json
-{
-  "mcpServers": {
-    "filesystem": {
-      "command": "pathgate",
-      "args": ["C:\\Users\\<username>\\Documents"]
-    }
-  }
-}
-```
 
 ## Example requests
 
@@ -135,7 +148,7 @@ pathgate/
 ## Requirements
 
 - Python 3.10+
-- `mcp>=1.25`
+- `mcp>=2`
 
 ## References
 

{pathgate-0.2.0 → pathgate-0.2.2}/README.md

@@ -1,4 +1,4 @@
-# Pathgate
+# Pathgate 
 
 `pathgate` is a Python Model Context Protocol (MCP) server that exposes a controlled filesystem interface to MCP clients such as Claude Desktop, Cursor, VS Code, and inspector tools. The server only permits access to directories that are explicitly allow-listed at startup.
 
@@ -21,13 +21,40 @@ Access is restricted by allow-listed paths. At startup, the server resolves the
 
 ## Installation
 
+Pathgate package is published on PyPI. To use it, for example with Claude Desktop, add this in the 
+
+```json
+{
+  "mcpServers": {
+    "pathgate": {
+      "command": "uvx",
+      "args": ["pathgate", "C:\\Users\\me\\Documents"]
+    }
+  }
+}
+```
+
+Or, you can use the install command to directly write the config file
+
 ```bash
-git clone https://github.com/geekgod382/pathgate.git
-cd pathgate
-python -m pip install -e .
+uvx pathgate install <paths>
 ```
 
-This installs the `pathgate` console command from `pyproject.toml`.
+paths should have nothing between them
+
+```bash
+uvx pathgate install C:\Users\me\Documents C:\Users\me\Projects
+```
+
+When no paths are given, it prompts you for them.
+
+### Options
+
+`--read-only:` writes the safer variant of the entry.
+`--dry-run`: shows what it would write and changes nothing.
+`--yes`: skips the confirmation prompt.
+`--name`: sets a different entry name (default pathgate).
+`--config PATH`: I build this mcp server for Claude primarily. Using this option edits a specific file, which also works for other clients that use the same mcpServers shape.
 
 ## Usage
 
@@ -67,20 +94,6 @@ The current implementation exposes these tools:
 - `search_files_tool` — search for files matching a pattern
 - `get_file_info_tool` — return metadata for a file or directory
 
-## MCP client configuration
-
-Example Claude Desktop configuration:
-
-```json
-{
-  "mcpServers": {
-    "filesystem": {
-      "command": "pathgate",
-      "args": ["C:\\Users\\<username>\\Documents"]
-    }
-  }
-}
-```
 
 ## Example requests
 
@@ -125,7 +138,7 @@ pathgate/
 ## Requirements
 
 - Python 3.10+
-- `mcp>=1.25`
+- `mcp>=2`
 
 ## References
 

pathgate-0.2.2/pathgate/install.py

@@ -0,0 +1,254 @@
+"""`pathgate install` - add Pathgate to Claude Desktop's config file.
+
+Usage:
+    uvx pathgate install C:\\Users\\me\\Documents C:\\Users\\me\\Projects
+    uvx pathgate install            (prompts for folders)
+    uvx pathgate install --dry-run ~/Projects
+"""
+
+from __future__ import annotations
+
+import argparse
+import json
+import os
+import shutil
+import sys
+import tempfile
+from datetime import datetime
+from pathlib import Path
+
+DEFAULT_NAME = "pathgate"
+CONFIG_FILENAME = "claude_desktop_config.json"
+
+
+class InstallError(Exception):
+    """A problem we can explain to the user in one line."""
+
+
+# --------------------------------------------------------------------------
+# Finding the config file
+# --------------------------------------------------------------------------
+
+def claude_desktop_candidates() -> list[Path]:
+    """Every place Claude Desktop might keep its config on this OS."""
+    if sys.platform == "win32":
+        found: list[Path] = []
+        appdata = os.environ.get("APPDATA")
+        if appdata:
+            found.append(Path(appdata) / "Claude" / CONFIG_FILENAME)
+        local = os.environ.get("LOCALAPPDATA")
+        if local:
+            # Microsoft Store (MSIX) installs keep their own private copy.
+            pattern = "Claude_*/LocalCache/Roaming/Claude"
+            for folder in sorted(Path(local, "Packages").glob(pattern)):
+                found.append(folder / CONFIG_FILENAME)
+        return found
+    if sys.platform == "darwin":
+        base = Path.home() / "Library" / "Application Support" / "Claude"
+        return [base / CONFIG_FILENAME]
+    xdg = os.environ.get("XDG_CONFIG_HOME")
+    base = Path(xdg) if xdg else Path.home() / ".config"
+    return [base / "Claude" / CONFIG_FILENAME]
+
+
+def resolve_config_path(explicit: str | None) -> Path:
+    if explicit:
+        return Path(explicit).expanduser().resolve()
+
+    candidates = claude_desktop_candidates()
+    usable = [c for c in candidates if c.exists() or c.parent.exists()]
+    existing = [c for c in usable if c.exists()]
+
+    if len(existing) == 1:
+        return existing[0]
+    if not existing and len(usable) == 1:
+        return usable[0]
+    if not usable:
+        raise InstallError(
+            "couldn't find Claude Desktop's config folder. Is Claude Desktop "
+            "installed? You can point at a config file yourself with --config PATH."
+        )
+    listing = "\n  ".join(str(c) for c in usable)
+    raise InstallError(
+        "found more than one possible Claude Desktop config:\n  "
+        f"{listing}\nRe-run with --config PATH to say which one."
+    )
+
+
+# --------------------------------------------------------------------------
+# Building the entry
+# --------------------------------------------------------------------------
+
+def build_server_entry(paths: list[str], read_only: bool) -> dict:
+    """The `mcpServers` entry that launches Pathgate."""
+    uvx = shutil.which("uvx")
+    uv = shutil.which("uv")
+    if uvx:
+        command, args = uvx, ["pathgate"]
+    elif uv:
+        command, args = uv, ["tool", "run", "pathgate"]
+    else:
+        command, args = sys.executable, ["-m", "pathgate"]
+    args = args + paths
+    if read_only:
+        args.append("--read-only")
+    return {"command": command, "args": args}
+
+
+# --------------------------------------------------------------------------
+# Reading / writing the config safely
+# --------------------------------------------------------------------------
+
+def load_config(path: Path) -> dict:
+    if not path.exists():
+        return {}
+    raw = path.read_text(encoding="utf-8-sig")  # tolerate a BOM
+    if not raw.strip():
+        return {}
+    try:
+        data = json.loads(raw)
+    except json.JSONDecodeError as e:
+        raise InstallError(
+            f"{path} isn't valid JSON ({e}). I haven't changed anything - "
+            "fix the file by hand, then run this again."
+        ) from None
+    if not isinstance(data, dict):
+        raise InstallError(f"{path} doesn't contain a JSON object, so I left it alone.")
+    return data
+
+
+def write_config(path: Path, data: dict) -> Path | None:
+    """Back up the old file, then replace it atomically. Returns the backup path."""
+    path.parent.mkdir(parents=True, exist_ok=True)
+
+    backup = None
+    if path.exists():
+        stamp = datetime.now().strftime("%Y%m%d-%H%M%S")
+        backup = path.with_name(f"{path.name}.pathgate-{stamp}.bak")
+        shutil.copy2(path, backup)
+
+    fd, tmp = tempfile.mkstemp(dir=path.parent, prefix=path.name + ".", suffix=".tmp")
+    try:
+        with os.fdopen(fd, "w", encoding="utf-8", newline="\n") as f:
+            json.dump(data, f, indent=2, ensure_ascii=False)
+            f.write("\n")
+        os.replace(tmp, path)
+    except BaseException:
+        try:
+            os.unlink(tmp)
+        except OSError:
+            pass
+        raise
+    return backup
+
+
+# --------------------------------------------------------------------------
+# The command
+# --------------------------------------------------------------------------
+
+def _prompt_for_paths() -> list[str]:
+    print("Which folders should Pathgate be allowed to access?")
+    print("Enter one folder per line. Press Enter on an empty line when done.")
+    paths: list[str] = []
+    while True:
+        line = input("> ").strip().strip('"').strip("'")
+        if not line:
+            break
+        paths.append(line)
+    return paths
+
+
+def _clean_paths(raw: list[str]) -> list[str]:
+    cleaned: list[str] = []
+    for item in raw:
+        p = Path(item).expanduser().resolve()
+        if not p.is_dir():
+            raise InstallError(f"not a folder: {p}")
+        s = str(p)
+        if s not in cleaned:
+            cleaned.append(s)
+    return cleaned
+
+
+def _confirm(question: str) -> bool:
+    answer = input(f"{question} [Y/n] ").strip().lower()
+    return answer in ("", "y", "yes")
+
+
+def _install(args: argparse.Namespace) -> int:
+    interactive = sys.stdin.isatty()
+
+    raw_paths = list(args.paths)
+    if not raw_paths:
+        if not interactive:
+            raise InstallError(
+                "no folders given. Example: pathgate install C:\\Users\\me\\Documents"
+            )
+        raw_paths = _prompt_for_paths()
+        if not raw_paths:
+            raise InstallError("no folders given, nothing to do.")
+    paths = _clean_paths(raw_paths)
+
+    config_path = resolve_config_path(args.config)
+    data = load_config(config_path)
+    entry = build_server_entry(paths, args.read_only)
+
+    servers = data.setdefault("mcpServers", {})
+    if not isinstance(servers, dict):
+        raise InstallError(f'"mcpServers" in {config_path} isn\'t an object, so I left it alone.')
+
+    existing = servers.get(args.name)
+    if existing == entry:
+        print(f'"{args.name}" is already set up in {config_path}. Nothing to change.')
+        return 0
+
+    print(f"Config file : {config_path}")
+    print(f"Server name : {args.name}")
+    print(f"Command     : {entry['command']} {' '.join(entry['args'])}")
+    print("Folders     : " + ", ".join(paths))
+    print("Mode        : " + ("read-only" if args.read_only else "read/write"))
+    if existing is not None:
+        print(f'Note        : this replaces your current "{args.name}" entry.')
+
+    if args.dry_run:
+        print("\n--dry-run: nothing was written.")
+        return 0
+
+    if not args.yes:
+        if not interactive:
+            raise InstallError("not running in a terminal; pass --yes to proceed.")
+        if not _confirm("\nWrite this to the config?"):
+            print("Cancelled. Nothing was changed.")
+            return 1
+
+    servers[args.name] = entry
+    backup = write_config(config_path, data)
+
+    print(f'\nDone. Added "{args.name}" to {config_path}.')
+    if backup:
+        print(f"Backup of your old config: {backup}")
+    print("Now fully quit Claude Desktop (system tray -> Quit) and reopen it.")
+    return 0
+
+
+def main(argv: list[str] | None = None) -> int:
+    p = argparse.ArgumentParser(
+        prog="pathgate install",
+        description="Add Pathgate to Claude Desktop's config file.",
+    )
+    p.add_argument("paths", nargs="*", help="Folders Pathgate may access")
+    p.add_argument("--read-only", action="store_true", help="Disable write/delete/move/copy tools")
+    p.add_argument("--name", default=DEFAULT_NAME, help=f"Entry name in the config (default: {DEFAULT_NAME})")
+    p.add_argument("--config", metavar="PATH", help="Config file to edit (default: auto-detect Claude Desktop)")
+    p.add_argument("--dry-run", action="store_true", help="Show what would change without writing")
+    p.add_argument("-y", "--yes", action="store_true", help="Don't ask for confirmation")
+    args = p.parse_args(argv)
+
+    try:
+        return _install(args)
+    except InstallError as e:
+        print(f"error: {e}", file=sys.stderr)
+        return 1
+    except (KeyboardInterrupt, EOFError):
+        print("\nCancelled. Nothing was changed.", file=sys.stderr)
+        return 130

{pathgate-0.2.0 → pathgate-0.2.2}/pathgate/server.py

@@ -1,6 +1,7 @@
 import argparse
 import asyncio
 import os
+import sys
 from importlib.metadata import PackageNotFoundError, version
 from pathlib import Path
 
@@ -31,7 +32,10 @@ server = Server(
 
 
 def parse_args(argv=None):
-    p = argparse.ArgumentParser(prog="pathgate")
+    p = argparse.ArgumentParser(
+        prog="pathgate",
+        epilog="To add Pathgate to Claude Desktop automatically: pathgate install <folders>",
+    )
     p.add_argument("paths", nargs="*", help="Directories the server may access")
     p.add_argument("--read-only", action="store_true", help="Disable write/delete/move/copy tools")
     args = p.parse_args(argv)
@@ -55,10 +59,17 @@ async def _run():
 
 
 def main():
+    # `pathgate install ...` edits the Claude Desktop config instead of
+    # starting the server. (A folder literally named "install" can still be
+    # passed as ./install.)
+    if sys.argv[1:2] == ["install"]:
+        from pathgate.install import main as install_main
+        raise SystemExit(install_main(sys.argv[2:]))
+
     paths, read_only = parse_args()
     configure(paths, read_only)
     asyncio.run(_run())
 
 
 if __name__ == "__main__":
-    main()
+    main()

{pathgate-0.2.0 → pathgate-0.2.2}/pyproject.toml

@@ -4,7 +4,7 @@ build-backend = "hatchling.build"
 
 [project]
 name = "pathgate"
-version = "0.2.0"
+version = "0.2.2"
 description = "Filesystem MCP server with allow-listed directories"
 readme = "README.md"
 requires-python = ">=3.10"