obsidian_fetch 0.1.8 → 0.1.11

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: be242fb83e36e23491358f1109b2cf71b0b849d685aadc5752483733d8d92b3b
-  data.tar.gz: f960f0a39c9a008e35a27f4d420440583232907c8f2114be8df84de12f66a67d
+  metadata.gz: 996b482b6dcf13de18f54917084aa60f9470d6903596d449fb5a0a5c7c2c51cd
+  data.tar.gz: 5d76e2811f3f5e18de3a217fe570d168156e531ec20b86fbecbb74722ec82b58
 SHA512:
-  metadata.gz: '00738a009acd96f5545035d30a5c4fc96987c90d014abd62c2b159c09a4c3e2ee64bbc85ea454242f1c86b0124deafa06f2d1fba010fb0445a1e5a55434357f5'
-  data.tar.gz: bde26b406b1cad4f1554b17970ed8d79ab816cbd2735ff8542e82ebc53d3934b95d9f4ad5a03216141af0a0b125ed82d106a22008eb2ea7d6816b7acae1954eb
+  metadata.gz: 187c1f785491440b2f221ce29fd253cc57b421d31c458016c5577ba906f256fbbf510c9ae5de101084db49bf0d754b84466834ff7b500b4c96e72dc95383964b
+  data.tar.gz: 2eabd6144aa231db4900e563e315b7be74cc3cc7460f52a8f604c00d8108fe91fec9eaf334fb64e53fc109c19eca3d1ab34316883dc1718a38eb35903dcf9db2

data/README.md

@@ -1,19 +1,19 @@
 # ObsidianFetch
 
-MCP servers specialising in retrieving information from Obsidian vaults.
+MCP servers focused on fetching and presenting information from Obsidian vaults.
 
 The existing MCP server has the following drawbacks:
-- There are many commands, and when computational resources are limited, it can take a long time to load the prompt.
-- When reading a note labeled "LLM," it is necessary to search for the path first before loading it, but the LLM may not always follow this procedure.
-- Some tools have unnecessary options, causing the LLM to sometimes fail to invoke the tool correctly.
+- It supports many commands, which can cause slow prompt loading when computational resources are limited.
+- When reading a note labeled "Sample Note", it is necessary to search for its path first before loading it, but the LLM may not always follow this procedure.
+- Some tools include unnecessary options, leading the LLM to sometimes fail to invoke them correctly.
 
 These issues become particularly noticeable when running an LLM on a local GPU.  
-To address this, we developed a new MCP server that simply retrieves and loads a list of notes.
+To address this, we developed a new MCP server that simply retrieves and loads lists of notes.
 
-Additionally, the new server has the following features:
-- When the LLM tries to retrieve link information and searches with brackets like `[[link name]]`, it automatically removes characters that cannot be used in links.
-- When reading a file, if there are links pointing to the opened file, it displays them.
-	- Especially in network-style note tools like Obsidian, following such links to load related notes can be very powerful.
+The new server also provides the following additional features:
+- When the LLM attempts to retrieve link information by searching with brackets like `[[link name]]`, the server automatically removes any characters that cannot be used in links.
+- In addition to loading the note contents, it also displays backlinks—notes that link to the currently opened note.
+	- This allows the LLM to load and understand the connections between related notes via backlinks.
 
 ## Installation
 

data/exe/obsidian_fetch

@@ -24,7 +24,7 @@ tool 'read' do
     name = args[:name]
     # 名前が文字列でない場合
     next 'Name must be a string' unless name.is_a?(String)
-    ObsidianFetch::tool_read(vault, name)
+    vault.tool_read(name)
   end
 end
 
@@ -39,7 +39,7 @@ tool 'read_multiple' do
     # 名前が文字列の配列でない場合
     next 'Name must be an array of strings' unless names.is_a?(Array) && names.all? { |name| name.is_a?(String) }
     names.map do |name|
-      ObsidianFetch::tool_read(vault, name)
+      vault.tool_read(name)
     end.join("\n\n---\n\n")
   end
 end
@@ -53,7 +53,7 @@ tool 'list' do
     name = args[:name]
     # 名前が文字列でない場合
     next 'Name must be a string' unless name.is_a?(String)
-    ObsidianFetch::tool_list(vault, name)
+    vault.tool_list(name)
   end
 end
 
@@ -67,7 +67,7 @@ tool 'list_multiple' do
     # 名前が文字列の配列でない場合
     next 'Name must be an array of strings' unless names.is_a?(Array) && names.all? { |name| name.is_a?(String) }
     names.map do |name|
-      ObsidianFetch::tool_list(vault, name)
+      vault.tool_list(name)
     end.join("\n\n---\n\n")
   end
 end

data/lib/obsidian_fetch/version.rb

@@ -1,5 +1,5 @@
 # frozen_string_literal: true
 
 module ObsidianFetch
-  VERSION = "0.1.8"
+  VERSION = "0.1.11"
 end

data/lib/obsidian_fetch.rb

@@ -127,73 +127,124 @@ module ObsidianFetch
         file_pathes.uniq!
       end
     end
-  end
 
-  def self.tool_read vault, name
-    name = Vault.normalize_note_name(name)
-    file_pathes = vault.notes[name]
-    # 名前のノートが存在しない場合
-    if file_pathes.nil?
-      return "Note not found: #{name}" if vault.links_by_file_name[name].nil?
-      file_pathes = vault.links_by_file_name[name]
-      return <<~EOS
-        Note not found: #{name}
-        However, I found other notes linked to this note.
-        #{file_pathes.map { |file_path| "- #{file_path}" }.join("\n")}
-      EOS
-    end
-  
-    # 複数のファイルがある場合は、---とファイル名で区切って返す
-    file_pathes.map do |file_path|
-      content = open(file_path) { |f| f.read.force_encoding('UTF-8') }
-      link_notes = if vault.links_by_file_path[file_path].nil?
-        ""
-      else
-        <<~EOS
-          This note is linked by the following notes:
-          #{(vault.links_by_file_path[file_path] || []).shuffle.map { |file_path| "- #{File.basename(file_path, '.md')}" }.join("\n")}
-        EOS
+    public
+
+    def tool_read name
+      name = Vault.normalize_note_name(name)
+      file_pathes = @notes[name]
+
+      # 名前のノートが見つからないが、nameがパスっぽい場合は、パスを修正したうえでもう一度試す
+      preface = ""
+      if file_pathes.nil? && name.include?('/')
+        fixed_name = File.basename(name, '.md')
+        file_pathes = @notes[fixed_name]
+        if file_pathes.nil?
+          # もしも名前で見つからなければ、リンクにも存在しないか確認する
+          link_pathes = @links_by_file_name[fixed_name]
+          if link_pathes.nil?
+            return note_not_found(name)
+          else
+            # リンク先のノートが見つかった場合は、prefaceを追加する
+            preface = <<~EOS
+              Presumably a path was specified. The process was automatically renamed and processed.
+            EOS
+            return list_links(fixed_name, preface)
+          end
+        else
+          # ノート名が見つかった場合は、prefaceを追加する
+          preface = <<~EOS
+            Presumably a path was specified. The process was automatically renamed and processed.
+          EOS
+          return open_file(fixed_name, file_pathes, preface)
+        end
       end
-      preface = <<~EOS
-        The contents of the note '#{name}' is as follows.
-        #{link_notes}
-        ---
-  
-      EOS
-      preface + content
-    end.join("\n\n---\n\n")
-  end
-  
-  MAX_LIST_SIZE = 20
-  def self.tool_list vault, name
-    name = Vault.normalize_note_name(name)
-    split_name = name.split(/[\s　]+/)
-    matched_notes = vault.notes.select do |note_name, _file_pathes|
-      split_name.map {|name_part| note_name.include?(name_part) }.all?
+
+      # 名前のノートが存在しない場合
+      if file_pathes.nil?
+        return note_not_found(name) if @links_by_file_name[name].nil?
+        return list_links(name, preface)
+      end
+
+      open_file(name, file_pathes, preface)
     end
-    # 名前で検索したが見つからない場合
-    if matched_notes.empty?
-      has_found_link = vault.links_by_file_name[name] && !vault.links_by_file_name[name].empty?
-      return <<~EOS unless has_found_link
+
+    private def note_not_found name
+      return <<~EOS
         Note not found: #{name}
-        Search again with a substring or a string with a different notation.
       EOS
+    end
+
+    private def list_links name, preface
       return <<~EOS
+        #{preface}
         Note not found: #{name}
         However, I found other notes linked to this note.
-        #{vault.links_by_file_name[name].shuffle.map { |file_path| "- #{File.basename(file_path, '.md')}" }.join("\n")}
+        #{@links_by_file_name[name].shuffle.map { |file_path| "- #{File.basename(file_path, '.md')}" }.join("\n")}
       EOS
     end
-    # マッチした名前の数が多すぎる場合は、ランダムにMAX_LIST_SIZE個選ぶ
-    preface = "Notes matching '#{name}' are as follows.\n"
-    if matched_notes.size > MAX_LIST_SIZE
-      matched_notes = matched_notes.to_a.sample(MAX_LIST_SIZE).to_h
-      preface = "Too many notes matched. I will show you only #{MAX_LIST_SIZE} of them.\n" + preface
+
+    private def open_file name, file_pathes, preface
+      # 複数のファイルがある場合は、---とファイル名で区切って返す
+      result = file_pathes.map do |file_path|
+        content = open(file_path) { |f| f.read.force_encoding('UTF-8') }
+        link_notes = if @links_by_file_path[file_path].nil?
+          ""
+        else
+          <<~EOS
+            This note is linked by the following notes:
+            #{(@links_by_file_path[file_path] || []).shuffle.map { |file_path| "- #{File.basename(file_path, '.md')}" }.join("\n")}
+          EOS
+        end
+        metadata = <<~EOS
+          The contents of the note '#{name}' is as follows.
+          #{link_notes}
+          ---
+        EOS
+        metadata + content
+      end.join("\n\n---\n\n")
+      preface + result
+    end
+
+    MAX_LIST_SIZE = 20
+    def tool_list name
+      name = Vault.normalize_note_name(name)
+      split_name = name.split(/[\s　]+/)
+      # 空白文字で検索された場合は失敗した旨を返す
+      # 仮に全ノートからランダムなMAX_LIST_SIZEを返してしまうと、LLMが誤って呼び出した場合に偽の関連性を持ってしまうため
+      if split_name.empty?
+        return <<~EOS
+          It cannot be listed in a blank string.
+        EOS
+      end
+      matched_notes = @notes.select do |note_name, _file_pathes|
+        split_name.map {|name_part| note_name.include?(name_part) }.all?
+      end
+      # 名前で検索したが見つからない場合
+      if matched_notes.empty?
+        has_found_link = @links_by_file_name[name] && !@links_by_file_name[name].empty?
+        return <<~EOS unless has_found_link
+          Note not found: #{name}
+          Search again with a substring or a string with a different notation.
+        EOS
+        return <<~EOS
+          Note not found: #{name}
+          However, I found other notes linked to this note.
+          #{@links_by_file_name[name].shuffle.map { |file_path| "- #{File.basename(file_path, '.md')}" }.join("\n")}
+        EOS
+      end
+      # マッチした名前の数が多すぎる場合は、ランダムにMAX_LIST_SIZE個選ぶ
+      preface = "Notes matching '#{name}' are as follows.\n"
+      if matched_notes.size > MAX_LIST_SIZE
+        matched_notes = matched_notes.to_a.sample(MAX_LIST_SIZE).to_h
+        preface = "Too many notes matched. I will show you only #{MAX_LIST_SIZE} of them.\n" + preface
+      end
+      # マッチした名前のリストで返す
+      list = matched_notes.keys.shuffle.map do |note_name|
+        "- #{note_name}"
+      end.join("\n")
+      preface + list
     end
-    # マッチした名前のリストで返す
-    list = matched_notes.keys.shuffle.map do |note_name|
-      "- #{note_name}"
-    end.join("\n")
-    preface + list
   end
+
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: obsidian_fetch
 version: !ruby/object:Gem::Version
-  version: 0.1.8
+  version: 0.1.11
 platform: ruby
 authors:
 - sou7
 autorequire:
 bindir: exe
 cert_chain: []
-date: 2025-04-26 00:00:00.000000000 Z
+date: 2025-04-30 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: mcp-rb
@@ -65,5 +65,6 @@ requirements: []
 rubygems_version: 3.5.22
 signing_key:
 specification_version: 4
-summary: MCP servers specialising in retrieving information from Obsidian vaults.
+summary: MCP servers focused on fetching and presenting information from Obsidian
+  vaults
 test_files: []