obsidian_fetch 0.1.7 → 0.1.10

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 79b62e5dc9bdbca99d59118ab63228a2c00e7d8c62dacfde8a1dd4a4aca889cb
-  data.tar.gz: 6220a008d0f543538f3c409b5b63030c26c1a270e7c14a623e59256c3d77d994
+  metadata.gz: 5f1f3795373c330483a11d7c66fdb4bf44b7312a6f4065e7aefd230e9a4fe245
+  data.tar.gz: 8cd7c19f1780e3c9f89ca537f26ec5ad711073b7cd8e7ba07ed6a4d015b0b9e4
 SHA512:
-  metadata.gz: 61859ffd8983057f79b2b25565e27e69319a19106c60cd4bc07ca52665c451e0cd0f9c2aa9db508b28470836c9742341d10b1493162ccd222f078b3e60a17ca0
-  data.tar.gz: c9d6f2e06399394596ea93664523ae98ce0e2dfa90f059424db846675cf85f25b3d23273e1a04314fbce8bbd11a9d03959275568f23ae6275a47d650c7f4128e
+  metadata.gz: 0ea95a17289bd2ec4f5d940a947abea3c458febdec89ffb7695e58d2ad4ea5cb3f281194552e56ec6ebc4c67557cf6ca12aafeab9c5aad0e2373a3b7a484ff7d
+  data.tar.gz: 0a089431af584dba6faeafe73b8d86f41ee2dc42bcdd5ef640e56dd65421fb539eaf8107ed4cea5421bbda397103268b234f27c043546a366a4ed9137952f776

data/README.md

@@ -1,38 +1,36 @@
 # ObsidianFetch
 
-TODO: Delete this and the text below, and describe your gem
+MCP servers specialising in retrieving information from Obsidian vaults.
 
-Welcome to your new gem! In this directory, you'll find the files you need to be able to package up your Ruby library into a gem. Put your Ruby code in the file `lib/obsidian_fetch`. To experiment with that code, run `bin/console` for an interactive prompt.
+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.
 
-## Installation
+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.
 
-TODO: Replace `UPDATE_WITH_YOUR_GEM_NAME_IMMEDIATELY_AFTER_RELEASE_TO_RUBYGEMS_ORG` with your gem name right after releasing it to RubyGems.org. Please do not do it earlier due to security reasons. Alternatively, replace this section with instructions to install your gem from git if you don't plan to release to RubyGems.org.
+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.
+- Support for aliases.
 
-Install the gem and add to the application's Gemfile by executing:
+## Installation
 
 ```bash
-bundle add UPDATE_WITH_YOUR_GEM_NAME_IMMEDIATELY_AFTER_RELEASE_TO_RUBYGEMS_ORG
+gem install obsidian_fetch
 ```
 
-If bundler is not being used to manage dependencies, install the gem by executing:
+## Usage
 
 ```bash
-gem install UPDATE_WITH_YOUR_GEM_NAME_IMMEDIATELY_AFTER_RELEASE_TO_RUBYGEMS_ORG
+obsidian_fetch /path/to/your/vault
 ```
 
-## Usage
-
-TODO: Write usage instructions here
-
-## Development
-
-After checking out the repo, run `bin/setup` to install dependencies. Then, run `rake ` to run the tests. You can also run `bin/console` for an interactive prompt that will allow you to experiment.
-
-To install this gem onto your local machine, run `bundle exec rake install`. To release a new version, update the version number in `version.rb`, and then run `bundle exec rake release`, which will create a git tag for the version, push git commits and the created tag, and push the `.gem` file to [rubygems.org](https://rubygems.org).
-
 ## Contributing
 
-Bug reports and pull requests are welcome on GitHub at https://github.com/[USERNAME]/obsidian_fetch.
+Bug reports and pull requests are welcome on GitHub at https://github.com/soukouki/obsidian_fetch.
 
 ## License
 

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.7"
+  VERSION = "0.1.10"
 end

data/lib/obsidian_fetch.rb

@@ -127,73 +127,83 @@ 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")}
+    public
+
+    def tool_read name
+      name = Vault.normalize_note_name(name)
+      file_pathes = @notes[name]
+      # 名前のノートが存在しない場合
+      if file_pathes.nil?
+        return "Note not found: #{name}" if @links_by_file_name[name].nil?
+        file_pathes = @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
-      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?
-    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
-        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.
-        #{vault.links_by_file_name[name].shuffle.map { |file_path| "- #{File.basename(file_path, '.md')}" }.join("\n")}
-      EOS
+    
+      # 複数のファイルがある場合は、---とファイル名で区切って返す
+      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
+        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個選ぶ
-    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
+    
+    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.7
+  version: 0.1.10
 platform: ruby
 authors:
 - sou7
 autorequire:
 bindir: exe
 cert_chain: []
-date: 2025-04-26 00:00:00.000000000 Z
+date: 2025-04-29 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: mcp-rb