omnifocus_mcp 1.0.0

data/lib/omnifocus_mcp/tools/generators/query_omnifocus_debug.rb

@@ -0,0 +1,169 @@
+# frozen_string_literal: true
+
+require_relative "../../result"
+require_relative "../../infrastructure/script_runner"
+
+module OmnifocusMcp
+  module Tools
+    module Generators
+      # Debug variant of `QueryOmnifocus` that returns raw field information
+      # for a single sample item. Useful for understanding what fields are
+      # actually exposed by the OmniFocus JS API.
+      class QueryOmnifocusDebug
+        ENTITIES = %w[task project folder].freeze
+        private_constant :ENTITIES
+
+        # @param entity ['task'|'project'|'folder']
+        # @return [OmnifocusMcp::Result] +ok+ carries the parsed JSON Hash from the script
+        class << self
+          def call(entity)
+            require_relative "../operations/query_omnifocus_debug"
+
+            Operations::QueryOmnifocusDebug.call(entity)
+          end
+
+          # Build the OmniJS debug script for the given entity.
+          # @param entity [String] one of {ENTITIES}
+          def generate_debug_script(entity)
+            <<~JS
+              (() => {
+                try {
+                  let item;
+                  const entityType = "#{entity}";
+
+                  if (entityType === "task") {
+                    item = flattenedTasks[0];
+                  } else if (entityType === "project") {
+                    item = flattenedProjects[0];
+                  } else if (entityType === "folder") {
+                    item = flattenedFolders[0];
+                  }
+
+                  if (!item) {
+                    return JSON.stringify({ error: "No items found" });
+                  }
+
+                  const properties = {};
+                  const skipProps = ['constructor', 'toString', 'valueOf'];
+
+                  for (let prop in item) {
+                    if (skipProps.includes(prop)) continue;
+
+                    try {
+                      const value = item[prop];
+                      const valueType = typeof value;
+
+                      if (value === null) {
+                        properties[prop] = { type: 'null', value: null };
+                      } else if (value === undefined) {
+                        properties[prop] = { type: 'undefined', value: undefined };
+                      } else if (valueType === 'function') {
+                        properties[prop] = { type: 'function', value: '[Function]' };
+                      } else if (value instanceof Date) {
+                        properties[prop] = { type: 'Date', value: value.toISOString() };
+                      } else if (Array.isArray(value)) {
+                        properties[prop] = {
+                          type: 'Array',
+                          length: value.length,
+                          sample: value.length > 0 ? value[0] : null
+                        };
+                      } else if (valueType === 'object') {
+                        if (value.id && value.id.primaryKey) {
+                          properties[prop] = {
+                            type: 'OFObject',
+                            id: value.id.primaryKey,
+                            name: value.name || null
+                          };
+                        } else {
+                          properties[prop] = { type: 'object', keys: Object.keys(value) };
+                        }
+                      } else {
+                        properties[prop] = { type: valueType, value: value };
+                      }
+                    } catch (e) {
+                      properties[prop] = { type: 'error', error: e.toString() };
+                    }
+                  }
+
+                  const checkProps = [
+                    'id', 'name', 'note', 'flagged', 'dueDate', 'deferDate',
+                    'estimatedMinutes', 'modificationDate', 'creationDate',
+                    'completionDate', 'taskStatus', 'status', 'tasks', 'projects',
+                    'containingProject', 'parentFolder', 'parent', 'children'
+                  ];
+
+                  const expectedProps = {};
+                  checkProps.forEach(prop => {
+                    try {
+                      const value = item[prop];
+                      if (value !== undefined) {
+                        if (value && value.id && value.id.primaryKey) {
+                          expectedProps[prop] = {
+                            exists: true,
+                            type: 'OFObject',
+                            id: value.id.primaryKey
+                          };
+                        } else if (value instanceof Date) {
+                          expectedProps[prop] = {
+                            exists: true,
+                            type: 'Date',
+                            value: value.toISOString()
+                          };
+                        } else if (Array.isArray(value)) {
+                          expectedProps[prop] = {
+                            exists: true,
+                            type: 'Array',
+                            length: value.length
+                          };
+                        } else {
+                          expectedProps[prop] = {
+                            exists: true,
+                            type: typeof value,
+                            value: value
+                          };
+                        }
+                      } else {
+                        expectedProps[prop] = { exists: false };
+                      }
+                    } catch (e) {
+                      expectedProps[prop] = { exists: false, error: e.toString() };
+                    }
+                  });
+
+                  return JSON.stringify({
+                    entityType: entityType,
+                    itemName: item.name || 'Unnamed',
+                    allProperties: properties,
+                    expectedProperties: expectedProps
+                  }, null, 2);
+
+                } catch (error) {
+                  return JSON.stringify({ error: error.toString() });
+                }
+              })();
+            JS
+          end
+
+          private
+
+          def classify_response(response)
+            shape = response.is_a?(Hash) ? response.transform_keys(&:to_sym) : nil
+
+            case shape
+            in { error: String => msg }
+              OmnifocusMcp::Result.error(msg)
+            in Hash
+              OmnifocusMcp::Result.ok(response)
+            in nil
+              OmnifocusMcp::Result.error("Unexpected response from query_omnifocus_debug: #{response.inspect}")
+            end
+          end
+
+          def unknown_entity_message(entity)
+            "Unknown entity: #{entity.inspect}. Must be one of #{ENTITIES.join(", ")}"
+          end
+        end
+      end
+    end
+  end
+end

data/lib/omnifocus_mcp/tools/generators/remove_item.rb

@@ -0,0 +1,61 @@
+# frozen_string_literal: true
+
+require_relative "../../infrastructure/apple_script"
+require_relative "../../utils/blank"
+require_relative "../params"
+
+module OmnifocusMcp
+  module Tools
+    module Generators
+      class RemoveItem
+        class << self
+          def generate_apple_script(params = nil, **kwargs)
+            merge_params(params, kwargs).then do |params|
+              params = Params::McpBoundary.coerce(Params::RemoveItemParams, params)
+              return missing_identifier_error if Utils::Blank.blank?(params.id, params.name)
+
+              id = Infrastructure::AppleScript.escape(params.id.to_s)
+              name = Infrastructure::AppleScript.escape(params.name.to_s)
+              item_type = params.item_type.to_s
+
+              Infrastructure::AppleScript.tell_document(document_body(item_type:, id:, name:))
+            end
+          end
+
+          private
+
+          def merge_params(params, kwargs)
+            return params || {} if kwargs.empty?
+
+            base = params.respond_to?(:to_h) ? params.to_h : params || {}
+            base.merge(kwargs)
+          end
+
+          def missing_identifier_error
+            %(return "{\\"success\\":false,\\"error\\":\\"Either id or name must be provided\\"}")
+          end
+
+          def document_body(item_type:, id:, name:)
+            <<~APPLESCRIPT.chomp
+              -- Find the item to remove
+              #{Infrastructure::AppleScript.find_item(var: "foundItem", item_type: item_type, id: id, name: name)}
+              -- If we found the item, remove it
+              if foundItem is not missing value then
+                set itemName to name of foundItem
+                set itemId to id of foundItem as string
+
+                -- Delete the item
+                delete foundItem
+
+                -- Return success
+                return "{\\"success\\":true,\\"id\\":\\"" & itemId & "\\",\\"name\\":\\"" & itemName & "\\"}"
+              else
+                return "{\\"success\\":false,\\"error\\":\\"Item not found\\"}"
+              end if
+            APPLESCRIPT
+          end
+        end
+      end
+    end
+  end
+end

data/lib/omnifocus_mcp/tools/generators.rb

@@ -0,0 +1,8 @@
+# frozen_string_literal: true
+
+module OmnifocusMcp
+  module Tools
+    module Generators
+    end
+  end
+end

data/lib/omnifocus_mcp/tools/messages/add_omnifocus_task.rb

@@ -0,0 +1,53 @@
+# frozen_string_literal: true
+
+require_relative "../definitions/date_formatter"
+
+module OmnifocusMcp
+  module Tools
+    module Messages
+      module AddOmniFocusTask
+        class << self
+          def success(args, result)
+            location_text = location_for(args, result.placement)
+            tag_text = tag_text_for(args[:tags])
+            due_text = if args[:dueDate]
+                         " due on #{Definitions::DateFormatter.format_date(args[:dueDate],
+                                                                           style: :locale)}"
+                       else
+                         ""
+                       end
+            warning = placement_warning(args, result.placement)
+
+            %(✅ Task "#{args[:name]}" created successfully #{location_text}#{due_text}#{tag_text}.#{warning})
+          end
+
+          def failure(error) = "Failed to create task: #{error}"
+
+          private
+
+          def location_for(args, placement)
+            case placement
+            when "parent"  then "under the parent task"
+            when "project" then args[:projectName] ? %(in project "#{args[:projectName]}") : "in a project"
+            else                "in your inbox"
+            end
+          end
+
+          def tag_text_for(tags)
+            tags && !tags.empty? ? " with tags: #{tags.join(", ")}" : ""
+          end
+
+          def placement_warning(args, placement)
+            return "" if placement.nil? || placement == "parent"
+
+            parent_requested = args[:parentTaskId] || args[:parentTaskName]
+            return "" unless parent_requested
+
+            location = placement == "project" ? "in project" : "in inbox"
+            "\n⚠️ Parent not found; task created #{location}."
+          end
+        end
+      end
+    end
+  end
+end

data/lib/omnifocus_mcp/tools/messages/add_project.rb

@@ -0,0 +1,28 @@
+# frozen_string_literal: true
+
+require_relative "../definitions/date_formatter"
+
+module OmnifocusMcp
+  module Tools
+    module Messages
+      module AddProject
+        class << self
+          def success(args)
+            location = args[:folderName] ? %(in folder "#{args[:folderName]}") : "at the root level"
+            tags = args[:tags] && !args[:tags].empty? ? " with tags: #{args[:tags].join(", ")}" : ""
+            due = if args[:dueDate]
+                    " due on #{Definitions::DateFormatter.format_date(args[:dueDate], style: :locale)}"
+                  else
+                    ""
+                  end
+            sequential = args[:sequential] ? " (sequential)" : " (parallel)"
+
+            %(✅ Project "#{args[:name]}" created successfully #{location}#{due}#{tags}#{sequential}.)
+          end
+
+          def failure(error) = "Failed to create project: #{error}"
+        end
+      end
+    end
+  end
+end

data/lib/omnifocus_mcp/tools/messages/batch_remove_items.rb

@@ -0,0 +1,13 @@
+# frozen_string_literal: true
+
+module OmnifocusMcp
+  module Tools
+    module Messages
+      module BatchRemoveItems
+        class << self
+          def missing_identifier = "Each item must have either id or name provided to remove it."
+        end
+      end
+    end
+  end
+end

data/lib/omnifocus_mcp/tools/messages/edit_item.rb

@@ -0,0 +1,39 @@
+# frozen_string_literal: true
+
+module OmnifocusMcp
+  module Tools
+    module Messages
+      module EditItem
+        class << self
+          def missing_identifier = "Either id or name must be provided to edit an item."
+
+          def success(args, edited)
+            label = args[:itemType] == "task" ? "Task" : "Project"
+            changed = edited.changed_properties ? " (#{edited.changed_properties})" : ""
+            %(✅ #{label} "#{edited.name}" updated successfully#{changed}.)
+          end
+
+          def failure(args, error)
+            base = "Failed to update #{args[:itemType]}"
+            return base unless error
+
+            if error.include?("Item not found")
+              not_found_message(args)
+            else
+              "#{base}: #{error}"
+            end
+          end
+
+          private
+
+          def not_found_message(args)
+            msg = "#{args[:itemType].capitalize} not found"
+            msg += %( with ID "#{args[:id]}") if args[:id]
+            msg += %(#{args[:id] ? " or" : " with"} name "#{args[:name]}") if args[:name]
+            "#{msg}."
+          end
+        end
+      end
+    end
+  end
+end

data/lib/omnifocus_mcp/tools/messages/list_tools.rb

@@ -0,0 +1,15 @@
+# frozen_string_literal: true
+
+module OmnifocusMcp
+  module Tools
+    module Messages
+      module ListTools
+        class << self
+          def list_tags_failure(error) = "Failed to list tags: #{error}"
+          def list_perspectives_failure(error) = "Failed to list perspectives: #{error}"
+          def perspective_view_failure(error) = "Failed to get perspective view: #{error}"
+        end
+      end
+    end
+  end
+end

data/lib/omnifocus_mcp/tools/messages/remove_item.rb

@@ -0,0 +1,42 @@
+# frozen_string_literal: true
+
+module OmnifocusMcp
+  module Tools
+    module Messages
+      module RemoveItem
+        class << self
+          def missing_identifier = "Either id or name must be provided to remove an item."
+
+          def invalid_item_type(item_type)
+            "Invalid item type: #{item_type}. Must be either 'task' or 'project'."
+          end
+
+          def success(args, removed)
+            label = args[:itemType] == "task" ? "Task" : "Project"
+            %(✅ #{label} "#{removed.name}" removed successfully.)
+          end
+
+          def failure(args, error)
+            base = "Failed to remove #{args[:itemType]}"
+            return base unless error
+
+            if error.include?("Item not found")
+              not_found_message(args)
+            else
+              "#{base}: #{error}"
+            end
+          end
+
+          private
+
+          def not_found_message(args)
+            msg = "#{args[:itemType].capitalize} not found"
+            msg += %( with ID "#{args[:id]}") if args[:id]
+            msg += %(#{args[:id] ? " or" : " with"} name "#{args[:name]}") if args[:name]
+            "#{msg}."
+          end
+        end
+      end
+    end
+  end
+end

data/lib/omnifocus_mcp/tools/messages.rb

@@ -0,0 +1,8 @@
+# frozen_string_literal: true
+
+module OmnifocusMcp
+  module Tools
+    module Messages
+    end
+  end
+end

data/lib/omnifocus_mcp/tools/operations/add_omnifocus_task.rb

@@ -0,0 +1,74 @@
+# frozen_string_literal: true
+
+require_relative "../../infrastructure/script_runner"
+require_relative "../../parsers/apple_script_envelope"
+require_relative "../../result"
+require_relative "../generators/add_omnifocus_task"
+require_relative "../params"
+
+module OmnifocusMcp
+  module Tools
+    module Operations
+      class AddOmniFocusTask
+        Created = Generators::AddOmniFocusTask::Created
+
+        class << self
+          def call(params = nil, script_runner: Infrastructure::ScriptRunner, **kwargs)
+            merge_params(params, kwargs).then { new(script_runner:).call(it) }
+          end
+
+          def generate_apple_script(...) = Generators::AddOmniFocusTask.generate_apple_script(...)
+          def generate_bulk_apple_script(...) = Generators::AddOmniFocusTask.generate_bulk_apple_script(...)
+
+          private
+
+          def merge_params(params, kwargs)
+            return params || {} if kwargs.empty?
+
+            base = params.respond_to?(:to_h) ? params.to_h : params || {}
+            base.merge(kwargs)
+          end
+        end
+
+        def initialize(script_runner: Infrastructure::ScriptRunner, generator: Generators::AddOmniFocusTask)
+          @script_runner = script_runner
+          @generator = generator
+        end
+
+        def call(params)
+          params = Params::McpBoundary.coerce(Params::AddTaskParams, params)
+          generator.generate_apple_script(params).then { |script| run_script(script) }
+        rescue StandardError => e
+          OmnifocusMcp.logger.warn("[add_omnifocus_task] Error: #{e}")
+          OmnifocusMcp::Result.error(e.message || "Unknown error in add_omnifocus_task")
+        end
+
+        private
+
+        attr_reader :script_runner, :generator
+
+        def run_script(script)
+          stdout, stderr, status = script_runner.execute_applescript(script)
+
+          OmnifocusMcp.logger.warn("[add_omnifocus_task] AppleScript stderr: #{stderr}") if stderr && !stderr.empty?
+          return OmnifocusMcp::Result.error(applescript_run_failure(stderr:, status:)) unless status.success?
+
+          parse_result(stdout)
+        end
+
+        def parse_result(stdout)
+          Parsers::AppleScriptEnvelope.parse(stdout:, default_error: "Unknown error in add_omnifocus_task") do |hash|
+            OmnifocusMcp::Result.ok(Created.new(task_id: hash["taskId"], placement: hash["placement"]))
+          end
+        end
+
+        def applescript_run_failure(stderr:, status:)
+          exit_code = status.respond_to?(:exitstatus) ? status.exitstatus : status
+          message = "osascript failed (exit #{exit_code})"
+          message += ": #{stderr.strip}" unless stderr.nil? || stderr.empty?
+          message
+        end
+      end
+    end
+  end
+end

data/lib/omnifocus_mcp/tools/operations/add_project.rb

@@ -0,0 +1,75 @@
+# frozen_string_literal: true
+
+require_relative "../../infrastructure/script_runner"
+require_relative "../../parsers/apple_script_envelope"
+require_relative "../../result"
+require_relative "../generators/add_project"
+require_relative "../params"
+
+module OmnifocusMcp
+  module Tools
+    module Operations
+      class AddProject
+        Created = Data.define(:project_id)
+
+        class << self
+          def call(params = nil, script_runner: Infrastructure::ScriptRunner, **kwargs)
+            merge_params(params, kwargs).then { new(script_runner:).call(it) }
+          end
+
+          def generate_apple_script(params = nil, **)
+            Generators::AddProject.generate_apple_script(params, **)
+          end
+
+          private
+
+          def merge_params(params, kwargs)
+            return params || {} if kwargs.empty?
+
+            base = params.respond_to?(:to_h) ? params.to_h : params || {}
+            base.merge(kwargs)
+          end
+        end
+
+        def initialize(script_runner: Infrastructure::ScriptRunner, generator: Generators::AddProject)
+          @script_runner = script_runner
+          @generator = generator
+        end
+
+        def call(params)
+          params = Params::McpBoundary.coerce(Params::AddProjectParams, params)
+          generator.generate_apple_script(params).then { |script| run_script(script) }
+        rescue StandardError => e
+          OmnifocusMcp.logger.warn("[add_project] Error: #{e}")
+          OmnifocusMcp::Result.error(e.message || "Unknown error in add_project")
+        end
+
+        private
+
+        attr_reader :script_runner, :generator
+
+        def run_script(script)
+          stdout, stderr, status = script_runner.execute_applescript(script)
+
+          OmnifocusMcp.logger.warn("[add_project] AppleScript stderr: #{stderr}") if stderr && !stderr.empty?
+          return OmnifocusMcp::Result.error(applescript_run_failure(stderr:, status:)) unless status.success?
+
+          parse_result(stdout)
+        end
+
+        def parse_result(stdout)
+          Parsers::AppleScriptEnvelope.parse(stdout:, default_error: "Unknown error in add_project") do |hash|
+            OmnifocusMcp::Result.ok(Created.new(project_id: hash["projectId"]))
+          end
+        end
+
+        def applescript_run_failure(stderr:, status:)
+          exit_code = status.respond_to?(:exitstatus) ? status.exitstatus : status
+          message = "osascript failed (exit #{exit_code})"
+          message += ": #{stderr.strip}" unless stderr.nil? || stderr.empty?
+          message
+        end
+      end
+    end
+  end
+end

data/lib/omnifocus_mcp/tools/operations/batch_add_items/batch_item.rb

@@ -0,0 +1,38 @@
+# frozen_string_literal: true
+
+require_relative "../../../result"
+
+module OmnifocusMcp
+  module Tools
+    module Operations
+      class BatchAddItems
+        # In-flight bookkeeping for one item in a batch. The original payload
+        # and its position in the input array are read-only; status and result
+        # are mutated as the batch processes.
+        class BatchItem
+          attr_reader :payload, :index
+          attr_accessor :status, :result
+
+          def initialize(payload:, index:)
+            @payload = payload
+            @index = index
+            @status = :pending
+            @result = nil
+          end
+
+          def pending? = @status == :pending
+
+          def fail!(message)
+            @status = :failed
+            @result = OmnifocusMcp::Result.error(message)
+          end
+
+          def succeed!(value)
+            @status = :succeeded
+            @result = OmnifocusMcp::Result.ok(value)
+          end
+        end
+      end
+    end
+  end
+end