deepwork 0.5.1__py3-none-any.whl → 0.7.0__py3-none-any.whl

deepwork/core/adapters.py

@@ -55,12 +55,6 @@ class AgentAdapter(ABC):
     display_name: ClassVar[str]
     config_dir: ClassVar[str]
     skills_dir: ClassVar[str] = "skills"
-    skill_template: ClassVar[str] = "skill-job-step.md.jinja"
-    meta_skill_template: ClassVar[str] = "skill-job-meta.md.jinja"
-
-    # Instructions for reloading skills after sync (shown to users)
-    # Subclasses should override with platform-specific instructions.
-    reload_instructions: ClassVar[str] = "Restart your AI assistant session to use the new skills."
 
     # Mapping from generic SkillLifecycleHook to platform-specific event names.
     # Subclasses should override this to provide platform-specific mappings.
@@ -152,38 +146,6 @@ class AgentAdapter(ABC):
             raise AdapterError("No project root specified")
         return root / self.config_dir / self.skills_dir
 
-    def get_meta_skill_filename(self, job_name: str) -> str:
-        """
-        Get the filename for a job's meta-skill.
-
-        The meta-skill is the primary user interface for a job.
-        Can be overridden for different file formats.
-
-        Args:
-            job_name: Name of the job
-
-        Returns:
-            Meta-skill filename (e.g., "job_name/SKILL.md" for Claude)
-        """
-        return f"{job_name}/SKILL.md"
-
-    def get_step_skill_filename(self, job_name: str, step_id: str, exposed: bool = False) -> str:
-        """
-        Get the filename for a step skill.
-
-        All step skills use the same filename format. The exposed parameter
-        is used for template context (user-invocable frontmatter setting).
-
-        Args:
-            job_name: Name of the job
-            step_id: ID of the step
-            exposed: If True, skill is user-invocable (for template context). Default: False.
-
-        Returns:
-            Skill filename (e.g., "job_name.step_id/SKILL.md" for Claude)
-        """
-        return f"{job_name}.{step_id}/SKILL.md"
-
     def detect(self, project_root: Path | None = None) -> bool:
         """
         Check if this platform is available in the project.
@@ -260,6 +222,22 @@ class AgentAdapter(ABC):
         # Default implementation does nothing - subclasses can override
         return 0
 
+    def register_mcp_server(self, project_path: Path) -> bool:
+        """
+        Register the DeepWork MCP server with the platform.
+
+        Args:
+            project_path: Path to project root
+
+        Returns:
+            True if server was registered, False if already registered
+
+        Raises:
+            AdapterError: If registration fails
+        """
+        # Default implementation does nothing - subclasses can override
+        return False
+
 
 def _hook_already_present(hooks: list[dict[str, Any]], script_path: str) -> bool:
     """Check if a hook with the given script path is already in the list."""
@@ -296,12 +274,6 @@ class ClaudeAdapter(AgentAdapter):
     display_name = "Claude Code"
     config_dir = ".claude"
 
-    # Claude Code doesn't have a reload command - must restart session
-    reload_instructions: ClassVar[str] = (
-        "Type 'exit' to leave your current session, then run "
-        "'claude --resume' (your history will be maintained)."
-    )
-
     # Claude Code uses PascalCase event names
     hook_name_mapping: ClassVar[dict[SkillLifecycleHook, str]] = {
         SkillLifecycleHook.AFTER_AGENT: "Stop",
@@ -443,13 +415,25 @@ class ClaudeAdapter(AgentAdapter):
             return True
         return False
 
+    def _get_settings_template_path(self) -> Path:
+        """Get the path to the settings.json template for this adapter."""
+        return Path(__file__).parent.parent / "templates" / self.name / "settings.json"
+
+    def _load_required_permissions(self) -> list[str]:
+        """Load required permissions from the settings template file."""
+        settings_template = self._get_settings_template_path()
+        with open(settings_template, encoding="utf-8") as f:
+            template_settings = json.load(f)
+        result: list[str] = template_settings["permissions"]["allow"]
+        return result
+
     def sync_permissions(self, project_path: Path) -> int:
         """
         Sync required permissions to Claude Code settings.json.
 
-        Adds permissions for:
-        - .deepwork/** - full access to deepwork directory
-        - All deepwork CLI commands (deepwork:*)
+        Loads permissions from the settings template file at
+        templates/claude/settings.json and merges them into the
+        project's .claude/settings.json.
 
         Args:
             project_path: Path to project root
@@ -460,20 +444,7 @@ class ClaudeAdapter(AgentAdapter):
         Raises:
             AdapterError: If sync fails
         """
-        # Define required permissions for DeepWork functionality
-        # Uses ./ prefix for paths relative to project root (per Claude Code docs)
-        required_permissions = [
-            # Full access to .deepwork directory
-            "Read(./.deepwork/**)",
-            "Edit(./.deepwork/**)",
-            "Write(./.deepwork/**)",
-            # All deepwork CLI commands
-            "Bash(deepwork:*)",
-            # Job scripts that need to be executable
-            "Bash(./.deepwork/jobs/deepwork_jobs/make_new_job.sh:*)",
-        ]
-        # NOTE: When modifying required_permissions, update the test assertion in
-        # tests/unit/test_adapters.py::TestClaudeAdapter::test_sync_permissions_idempotent
+        required_permissions = self._load_required_permissions()
 
         # Load settings once, add all permissions, then save once
         settings = self._load_settings(project_path)
@@ -557,6 +528,65 @@ class ClaudeAdapter(AgentAdapter):
 
         return None
 
+    def register_mcp_server(self, project_path: Path) -> bool:
+        """
+        Register the DeepWork MCP server in .mcp.json at project root.
+
+        Claude Code reads MCP server configurations from .mcp.json (project scope),
+        not from settings.json. This method assumes the `deepwork` command is
+        available in the user's PATH.
+
+        Args:
+            project_path: Path to project root
+
+        Returns:
+            True if server was registered or updated, False if no changes needed
+
+        Raises:
+            AdapterError: If registration fails
+        """
+        mcp_file = project_path / ".mcp.json"
+
+        # Load existing .mcp.json or create new
+        existing_config: dict[str, Any] = {}
+        if mcp_file.exists():
+            try:
+                with open(mcp_file, encoding="utf-8") as f:
+                    existing_config = json.load(f)
+            except (json.JSONDecodeError, OSError) as e:
+                raise AdapterError(f"Failed to read .mcp.json: {e}") from e
+
+        # Initialize mcpServers if not present
+        if "mcpServers" not in existing_config:
+            existing_config["mcpServers"] = {}
+
+        # Build the new MCP server config
+        # Assume deepwork is available in PATH
+        new_server_config = {
+            "command": "deepwork",
+            "args": ["serve", "--path", "."],
+        }
+
+        # Check if already registered with same config
+        existing_server = existing_config["mcpServers"].get("deepwork", {})
+        if (
+            existing_server.get("command") == new_server_config["command"]
+            and existing_server.get("args") == new_server_config["args"]
+        ):
+            return False
+
+        # Register or update the DeepWork MCP server
+        existing_config["mcpServers"]["deepwork"] = new_server_config
+
+        # Write .mcp.json
+        try:
+            with open(mcp_file, "w", encoding="utf-8") as f:
+                json.dump(existing_config, f, indent=2)
+        except OSError as e:
+            raise AdapterError(f"Failed to write .mcp.json: {e}") from e
+
+        return True
+
 
 class GeminiAdapter(AgentAdapter):
     """Adapter for Gemini CLI.
@@ -574,52 +604,11 @@ class GeminiAdapter(AgentAdapter):
     name = "gemini"
     display_name = "Gemini CLI"
     config_dir = ".gemini"
-    skill_template = "skill-job-step.toml.jinja"
-    meta_skill_template = "skill-job-meta.toml.jinja"
-
-    # Gemini CLI can reload with /memory refresh
-    reload_instructions: ClassVar[str] = (
-        "Run '/memory refresh' to reload skills, or restart your Gemini CLI session."
-    )
 
     # Gemini CLI does NOT support skill-level hooks
     # Hooks are global/project-level in settings.json, not per-skill
     hook_name_mapping: ClassVar[dict[SkillLifecycleHook, str]] = {}
 
-    def get_meta_skill_filename(self, job_name: str) -> str:
-        """
-        Get the filename for a Gemini job's meta-skill.
-
-        Gemini uses TOML files and colon namespacing via subdirectories.
-        For job "my_job", creates: my_job/index.toml
-
-        Args:
-            job_name: Name of the job
-
-        Returns:
-            Meta-skill filename path (e.g., "my_job/index.toml")
-        """
-        return f"{job_name}/index.toml"
-
-    def get_step_skill_filename(self, job_name: str, step_id: str, exposed: bool = False) -> str:
-        """
-        Get the filename for a Gemini step skill.
-
-        Gemini uses TOML files and colon namespacing via subdirectories.
-        All step skills use the same filename format. The exposed parameter
-        is used for template context (user-invocable setting).
-        For job "my_job" and step "step_one", creates: my_job/step_one.toml
-
-        Args:
-            job_name: Name of the job
-            step_id: ID of the step
-            exposed: If True, skill is user-invocable (for template context). Default: False.
-
-        Returns:
-            Skill filename path (e.g., "my_job/step_one.toml")
-        """
-        return f"{job_name}/{step_id}.toml"
-
     def sync_hooks(self, project_path: Path, hooks: dict[str, list[dict[str, Any]]]) -> int:
         """
         Sync hooks to Gemini CLI settings.