enhance: dry run option for upsert-nodes

Also give an explicit error when incorrectly using mcp with file graphs.
Better than random errors that vary per tool

deps/cli/src/logseq/cli/commands/mcp_server.cljs

@@ -30,7 +30,8 @@
     conn
     ;; string is used by a -t invocation
     (-> (if (string? (.-operations args)) (js/JSON.parse (.-operations args)) (.-operations args))
-        (js->clj :keywordize-keys true)))))
+        (js->clj :keywordize-keys true))
+    {:dry-run (.-dry-run args)})))
 
 (def ^:private local-tools
   "MCP Tools when running with a local graph"

deps/cli/src/logseq/cli/common/mcp/server.cljs

@@ -114,7 +114,7 @@
 
 (defn- api-upsert-nodes
   [call-api-fn args]
-  (call-api-fn "logseq.cli.upsertNodes" [(aget args "operations")]))
+  (call-api-fn "logseq.cli.upsertNodes" [(aget args "operations") #js {:dry-run (aget args "dry-run")}]))
 
 (def ^:large-vars/data-var api-tools
   "MCP Tools when calling API server"
@@ -187,7 +187,8 @@
                 #js {:operation   (z/enum #js ["add" "edit"])
                      :entityType  (z/enum #js ["block" "page" "tag" "property"])
                      :id          (.optional (z/union #js [(z/string) (z/number) (z/null)]))
-                     :data        (-> (z/object #js {}) (.passthrough))}))}}}
+                     :data        (-> (z/object #js {}) (.passthrough))}))
+              :dry-run (-> (z/boolean) (.describe "Pretend to do batch update. Does everything except actually commit change to db e.g. validation."))}}}
    :searchBlocks
    {:fn api-search-blocks
     :config #js {:title "Search Blocks"

deps/cli/src/logseq/cli/common/mcp/tools.cljs

@@ -15,9 +15,15 @@
             [malli.core :as m]
             [malli.error :as me]))
 
+(defn- ensure-db-graph
+  [db]
+  (when-not (ldb/db-based-graph? db)
+    (throw (ex-info "This tool must be called on a DB graph" {}))))
+
 (defn list-properties
   "Main fn for ListProperties tool"
   [db]
+  (ensure-db-graph db)
   (->> (d/datoms db :avet :block/tags :logseq.class/Property)
        (map #(d/entity db (:e %)))
        #_((fn [x] (prn :prop-keys (distinct (mapcat keys x))) x))
@@ -36,6 +42,7 @@
 (defn list-tags
   "Main fn for ListTags tool"
   [db]
+  (ensure-db-graph db)
   (->> (d/datoms db :avet :block/tags :logseq.class/Tag)
        (map #(d/entity db (:e %)))
        (map (fn [e]
@@ -72,6 +79,7 @@
 (defn get-page-data
   "Get page data for GetPage tool including the page's entity and its blocks"
   [db page-name-or-uuid]
+  (ensure-db-graph db)
   (when-let [page (ldb/get-page db page-name-or-uuid)]
     {:entity (-> (remove-hidden-properties page)
                  (dissoc :block/tags :block/refs)
@@ -85,6 +93,7 @@
 (defn list-pages
   "Main fn for ListPages tool"
   [db]
+  (ensure-db-graph db)
   (->> (d/datoms db :avet :block/name)
        (map #(d/entity db (:e %)))
        (remove entity-util/hidden?)
@@ -309,20 +318,22 @@
                            " " (pr-str (:title (ex-data e))) " is invalid: " (ex-message e))
                       (ex-data e))))))
 
-(defn- summarize-upsert-operations [operations]
+(defn- summarize-upsert-operations [operations {:keys [dry-run]}]
   (let [counts (reduce (fn [acc op]
                          (let [entity-type (keyword (:entityType op))
                                operation-type (keyword (:operation op))]
                            (update-in acc [operation-type entity-type] (fnil inc 0))))
                        {}
                        operations)]
-    (str (when (counts :add)
+    (str (if dry-run "Dry run: " "")
+         (when (counts :add)
            (str "Added: " (pr-str (counts :add)) "."))
          (when (counts :edit)
            (str " Edited: " (pr-str (counts :edit)) ".")))))
 
 (defn upsert-nodes
-  [conn operations*]
+  [conn operations* {:keys [dry-run] :as opts}]
+  (ensure-db-graph @conn)
   ;; Only support these operations with appropriate outliner validations
   (when (seq (filter #(and (#{"page" "tag" "property"} (:entityType %)) (= "edit" (:operation %))) operations*))
     (throw (ex-info "Editing a page, tag or property isn't supported yet" {})))
@@ -351,5 +362,5 @@
           (assoc :properties properties))]
     (prn :import-edn import-edn)
     (validate-import-edn import-edn)
-    (import-edn-data conn import-edn)
-    (summarize-upsert-operations operations*)))
+    (when-not dry-run (import-edn-data conn import-edn))
+    (summarize-upsert-operations operations* opts)))

src/main/logseq/api.cljs

@@ -1185,8 +1185,10 @@
 
 (defn ^:export upsert_nodes
   "Given a list of MCP operations, batch upserts resulting EDN data"
-  [operations]
-  (p/let [resp (cli-common-mcp-tools/upsert-nodes (conn/get-db false) (js->clj operations :keywordize-keys true))]
+  [operations options]
+  (p/let [resp (cli-common-mcp-tools/upsert-nodes (conn/get-db false)
+                                                  (js->clj operations :keywordize-keys true)
+                                                  (js->clj options :keywordize-keys true))]
     (ui-handler/re-render-root!)
     resp))