castrel-proxy 0.1.0__py3-none-any.whl

castrel_proxy/data/default_whitelist.txt

@@ -0,0 +1,229 @@
+# Castrel Default Command Whitelist
+# One command name per line, lines starting with # are comments
+# Only commands in this whitelist are allowed to execute
+
+# ========== File and Directory Operations ==========
+ls
+ll
+cat
+head
+tail
+find
+pwd
+cd
+mkdir
+touch
+cp
+ln
+tree
+stat
+file
+readlink
+realpath
+basename
+dirname
+
+# ========== Text Processing ==========
+grep
+egrep
+fgrep
+awk
+sed
+sort
+uniq
+wc
+diff
+cut
+tr
+xargs
+tee
+less
+more
+
+# ========== Version Control ==========
+git
+svn
+
+# ========== Development Tools - Python ==========
+python
+python3
+pip
+pip3
+poetry
+uv
+pipenv
+conda
+virtualenv
+
+# ========== Development Tools - Node.js ==========
+node
+npm
+npx
+yarn
+pnpm
+bun
+
+# ========== Development Tools - Other Languages ==========
+make
+cmake
+cargo
+rustc
+go
+java
+javac
+mvn
+gradle
+ruby
+gem
+php
+composer
+
+# ========== Network Tools (Read-only) ==========
+curl
+wget
+ping
+traceroute
+tracepath
+nslookup
+dig
+host
+
+# ========== Compression and Archiving ==========
+tar
+zip
+unzip
+gzip
+gunzip
+bzip2
+bunzip2
+xz
+unxz
+7z
+rar
+unrar
+
+# ========== System Information (Read-only) ==========
+echo
+which
+whereis
+env
+printenv
+date
+whoami
+id
+hostname
+uname
+uptime
+w
+who
+last
+history
+ps
+top
+htop
+free
+df
+du
+lsof
+vmstat
+iostat
+sar
+mpstat
+pidstat
+nproc
+lsblk
+blkid
+
+# ========== Process Management (Safe) ==========
+nohup
+bg
+fg
+jobs
+screen
+tmux
+journalctl
+
+# ========== Network Information (Read-only) ==========
+ip
+ifconfig
+netstat
+ss
+
+# ========== Docker (Client Commands) ==========
+docker
+docker-compose
+buildx
+docker-buildx
+
+# ========== Kubernetes (Client Commands) ==========
+kubectl
+helm
+helmfile
+kustomize
+skaffold
+tilt
+k9s
+stern
+kubectx
+kubens
+kubie
+minikube
+kind
+k3s
+k3d
+microk8s
+argocd
+flux
+fluxctl
+velero
+restic
+istioctl
+linkerd
+oc
+eksctl
+gcloud
+az
+aws
+
+# ========== Container Image Tools ==========
+podman
+buildah
+skopeo
+nerdctl
+kaniko
+dive
+trivy
+grype
+syft
+
+# ========== Logging ==========
+logger
+
+# ========== Binary Analysis (Read-only) ==========
+objdump
+nm
+ldd
+
+# ========== Editors ==========
+vim
+vi
+nano
+emacs
+
+# ========== Other Common Tools ==========
+watch
+timeout
+time
+sleep
+test
+true
+false
+yes
+seq
+shuf
+base64
+md5sum
+sha256sum
+openssl
+jq
+yq

castrel_proxy/mcp/__init__.py

@@ -0,0 +1,8 @@
+"""MCP (Model Context Protocol) integration modules"""
+
+from .manager import MCPManager, get_mcp_manager
+
+__all__ = [
+    "MCPManager",
+    "get_mcp_manager",
+]

castrel_proxy/mcp/manager.py

@@ -0,0 +1,278 @@
+"""
+MCP Manager Module
+
+Responsible for managing MCP client connections and fetching tools information
+"""
+
+import json
+import logging
+import sys
+from pathlib import Path
+from typing import Dict, List, Optional
+from langchain_mcp_adapters.client import MultiServerMCPClient
+
+logger = logging.getLogger(__name__)
+
+
+def convert_config_to_langchain_format(config_data: dict) -> dict:
+    """
+    Convert configuration to langchain-mcp-adapters format
+
+    Args:
+        config_data: Original configuration data
+
+    Returns:
+        dict: Configuration in langchain format
+
+    Raises:
+        ValueError: When configuration is invalid
+    """
+    langchain_config = {}
+
+    for name, server_config in config_data.items():
+        # Validate required transport key
+        if "transport" not in server_config:
+            error_msg = (
+                f"Configuration error for server '{name}': Missing 'transport' key. "
+                f"Each server must include 'transport' with one of: 'stdio', 'sse', 'http'. "
+            )
+            logger.error(error_msg)
+            raise ValueError(error_msg)
+
+        transport = server_config.get("transport")
+
+        if transport == "stdio":
+            # stdio type: use command and args
+            if not server_config.get("command"):
+                error_msg = f"Configuration error for server '{name}': Missing 'command' for stdio transport"
+                logger.error(error_msg)
+                raise ValueError(error_msg)
+
+            langchain_config[name] = {
+                "transport": "stdio",
+                "command": server_config.get("command"),
+                "args": server_config.get("args", []),
+            }
+            # Add environment variables if present
+            if server_config.get("env"):
+                langchain_config[name]["env"] = server_config.get("env")
+
+        elif transport == "http":
+            # http type: use url
+            if not server_config.get("url"):
+                error_msg = f"Configuration error for server '{name}': Missing 'url' for http transport"
+                logger.error(error_msg)
+                raise ValueError(error_msg)
+
+            langchain_config[name] = {
+                "transport": "http",
+                "url": server_config.get("url"),
+            }
+
+        elif transport in ["sse", "websocket"]:
+            error_msg = (
+                f"Configuration error for server '{name}': Transport type '{transport}' is not yet supported. "
+                f"Currently supported transports: 'stdio', 'http'"
+            )
+            logger.error(error_msg)
+            raise ValueError(error_msg)
+
+        else:
+            error_msg = (
+                f"Configuration error for server '{name}': Unknown transport type '{transport}'. "
+                f"Supported transports: 'stdio', 'http'"
+            )
+            logger.error(error_msg)
+            raise ValueError(error_msg)
+
+    return langchain_config
+
+
+class MCPManager:
+    """MCP manager"""
+
+    def __init__(self, config_file: Optional[Path] = None):
+        """
+        Initialize MCP manager
+
+        Args:
+            config_file: Configuration file path, defaults to ~/.castrel/mcp.json
+        """
+        if config_file is None:
+            self.config_file = Path.home() / ".castrel" / "mcp.json"
+        else:
+            self.config_file = Path(config_file)
+
+        self.client: Optional[MultiServerMCPClient] = None
+        self.server_configs: Dict = {}
+
+    def load_config(self) -> Dict:
+        """
+        Load MCP configuration
+
+        Returns:
+            Dict: Configuration dictionary in langchain format
+        """
+        if not self.config_file.exists():
+            logger.warning(f"MCP configuration file does not exist: {self.config_file}")
+            return {}
+
+        try:
+            with open(self.config_file, "r", encoding="utf-8") as f:
+                data = json.load(f)
+
+            mcpServers = data.get("mcpServers", {})
+
+            logger.info(f"Loaded {len(mcpServers)} MCP configurations")
+            return mcpServers
+
+        except Exception as e:
+            logger.error(f"Failed to load MCP configuration: {e}")
+            return {}
+
+    def get_server_list(self) -> List[Dict]:
+        """
+        Get server configuration list (for display)
+
+        Returns:
+            List[Dict]: Server configuration list
+        """
+        if not self.config_file.exists():
+            return []
+
+        try:
+            with open(self.config_file, "r", encoding="utf-8") as f:
+                data = json.load(f)
+
+            servers = []
+            mcpServers = data.get("mcpServers", {})
+
+            for name, config in mcpServers.items():
+                servers.append(
+                    {
+                        "name": name,
+                        "transport": config.get("transport", "stdio"),
+                        "command": config.get("command", ""),
+                        "args": config.get("args", []),
+                        "url": config.get("url", ""),
+                        "env": config.get("env", {}),
+                    }
+                )
+
+            return servers
+
+        except Exception as e:
+            logger.error(f"Failed to get server list: {e}")
+            return []
+
+    async def connect_all(self) -> int:
+        """
+        Connect to all configured MCP services
+
+        Returns:
+            int: Number of successfully connected services
+
+        Raises:
+            SystemExit: When configuration is invalid
+        """
+        raw_config = self.load_config()
+        if not raw_config:
+            logger.info("No MCP services configured")
+            return 0
+
+        try:
+            # Convert configuration to langchain format
+            logger.info(f"Converting configuration for {len(raw_config)} MCP services...")
+            self.server_configs = convert_config_to_langchain_format(raw_config)
+
+            logger.info(f"Connecting to {len(self.server_configs)} MCP services...")
+
+            # Create MultiServerMCPClient
+            self.client = MultiServerMCPClient(self.server_configs)
+
+            logger.info(f"Successfully connected to {len(self.server_configs)} MCP services")
+            return len(self.server_configs)
+
+        except ValueError as e:
+            # Configuration error - exit immediately
+            logger.error(f"Configuration error: {e}")
+            logger.error("Exiting due to invalid MCP configuration")
+            sys.exit(1)
+
+        except Exception as e:
+            logger.error(f"Failed to connect to MCP services: {e}")
+            logger.error("Exiting due to MCP connection failure")
+            sys.exit(1)
+
+    async def get_all_tools(self) -> Dict[str, List[Dict]]:
+        """
+        Get tools from all MCP services
+
+        Returns:
+            Dict[str, List[Dict]]: All tools list
+
+        Raises:
+            SystemExit: When MCP client is not initialized or tools retrieval fails
+        """
+        if not self.client:
+            logger.error("MCP client not initialized")
+            logger.error("Exiting due to uninitialized MCP client")
+            sys.exit(1)
+
+        try:
+            # Use MultiServerMCPClient to get all tools
+            result = {}
+            count = 0
+            for server_name in self.server_configs:
+                tools = await self.client.get_tools(server_name=server_name)
+                # Convert to required format
+                formatted_tools = []
+                for tool in tools:
+                    # Tool format returned by langchain-mcp-adapters
+                    tool_info = {
+                        "name": tool.name,
+                        "description": tool.description or "",
+                        "inputSchema": tool.args_schema if hasattr(tool, "args_schema") else {},
+                        "mcp_server": getattr(tool, "server_name", "unknown"),
+                    }
+                    formatted_tools.append(tool_info)
+                count = count + len(formatted_tools)
+                result[server_name] = formatted_tools
+
+            if count == 0:
+                logger.warning("No tools retrieved from any MCP server")
+                logger.warning("Exiting due to zero tools retrieved")
+                sys.exit(1)
+
+            logger.info(f"Retrieved {count} tool(s)")
+            return result
+
+        except Exception as e:
+            # Check if it's a configuration error
+            if "Configuration error" in str(e) or "Missing 'transport' key" in str(e):
+                logger.error(f"Configuration error while getting MCP tools: {e}")
+                logger.error("Exiting due to invalid MCP configuration")
+                sys.exit(1)
+            else:
+                logger.error(f"Failed to get MCP tools: {e}")
+                logger.error("Exiting due to MCP tools retrieval failure")
+                sys.exit(1)
+
+    async def disconnect_all(self):
+        """Disconnect all MCP connections"""
+        if self.client:
+            try:
+                # MultiServerMCPClient manages connections automatically
+                self.client = None
+                logger.info("All MCP services disconnected")
+            except Exception as e:
+                logger.error(f"Failed to disconnect MCP services: {e}")
+
+
+# Global MCP manager instance
+_mcp_manager = MCPManager()
+
+
+def get_mcp_manager() -> MCPManager:
+    """Get global MCP manager instance"""
+    return _mcp_manager

castrel_proxy/network/__init__.py

@@ -0,0 +1,13 @@
+"""Network communication modules for Castrel Bridge Proxy"""
+
+from .api_client import APIClient, APIError, NetworkError, PairingError, get_api_client
+from .websocket_client import WebSocketClient
+
+__all__ = [
+    "APIClient",
+    "APIError",
+    "NetworkError",
+    "PairingError",
+    "get_api_client",
+    "WebSocketClient",
+]