obsidian_fetch 1.2.0 → 1.3.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: f05f834b38c590fcbccce689668144c14f442bf7ff08899e04f2feb1f807eb95
-  data.tar.gz: cc9d23ced95dd85719d0f0666a3363929e40ff8b2983962cc58930e3d2793157
+  metadata.gz: 6b142d17c24902e0a12e9cec6e76cd0b013847ec51f32e25ce902cd882eab987
+  data.tar.gz: 4c3783977dd9554b9bcba102a73b77a5a59d6e5915004cd3a304011e91a08588
 SHA512:
-  metadata.gz: 366348161c4e8a2352c9a715787f9f86ebb96d0aee0878d83720a4da623d3ab378878e5dd4c0c86ba9dc1ef92421c27f162c40dcbbfadf0ea033c35d5cf6fc19
-  data.tar.gz: 731c8660944590029ab2383da67fb2cfc8499bc89ef7bcde7460798b62651df76e7ec104f79165048a6d20a76760c93f3cf52c271a8cb84d5d4bcf4b5252d004
+  metadata.gz: c550ba9a5d0c37f0a35d46f4667a1c7d4b79fedf4e10120e7f64877d9b34e5312ae1d913e74056317b5274ad90bf95bdeeec855fb3d146003b8fe656d40679ee
+  data.tar.gz: 17cd3805955d03eec7030e52ed07cb4f32c41f65cae11f1fc34a9ea07ffb0b0b4792fc4564b941b9347824a24d327a8f4ff56c3197eaf061101034e30d41820b

data/CHANGELOG.md

@@ -1,5 +1,43 @@
 ## [Unreleased]
 
+## [1.3.0] - 2026-10-28
+
+- Dependencies: mcp 1.8.2 (constraint `~> 1.8`), puma 8.0.2, rack 3.2.7, simplecov 1.3.2. Required Ruby is 3.3.0 or later.
+- list tool: stopped shuffling. Results are ordered by note name, compared case-insensitively with an ASCII tiebreak. Backlinks, link fallback lists and file enumerations are ordered the same way. When the result is truncated by limit, the truncated priority group shows its head and tail with a line reporting the omitted count.
+- list tool: added the `limit` argument (1 to 200, default 20) and the total number of matches in the response.
+- list tool: folder names are searched, matches are ranked by the distance from the file, and the response reports the breakdown of matches.
+- read tool: a case-insensitive fuzzy match is accepted when no exact match exists, and case variants are suggested when an exact match exists.
+- The initialize response advertises only the tools capability.
+
+## [1.2.0] - 2026-07-10
+
+- Vault files are reloaded when they change.
+- isError handling was added to the tools.
+- Tests were restructured and coverage measurement was added.
+
+## [1.1.2] - 2026-04-28
+
+- The Puma bind address was changed from 127.0.0.1 to 0.0.0.0 to allow external access.
+- The `enable_json_response` option added in 1.1.1 was reverted.
+
+## [1.1.1] - 2026-04-28
+
+- Added the `enable_json_response` option for mcp 0.14.0.
+
+## [1.1.0] - 2026-04-28
+
+- Added the Streamable HTTP transport.
+- README was made multilingual.
+- The mcp gem was upgraded to 0.14.0.
+
+## [1.0.0] - 2025-08-20
+
+- Switched to the official MCP Ruby SDK.
+- Fixed the way tools are specified.
+- read tool normalizes a path given as `name`.
+- Display shows note names instead of paths.
+- Refactored and extended the list tool.
+
 ## [0.1.0] - 2025-04-27
 
 - Initial release

data/README.md

@@ -48,7 +48,7 @@ obsidian_fetch /path/to/your/vault --transport streamable-http --port 3000
 ## Tools
 
 - **read**: Read a note from the Obsidian vault. If multiple notes with the same name are found, all will be shown.
-- **list**: Search for files with matching names partially.
+- **list**: Search for notes whose name or containing folder names partially match. It returns 20 notes by default. The `limit` argument accepts an integer between 1 and 200, and the response states how many notes matched in total.
 
 ## Contributing
 

data/README_ja.md

@@ -52,7 +52,7 @@ obsidian_fetch /path/to/your/vault --transport streamable-http --port 3000
 ## ツール
 
 - **read**: Obsidian Vaultからノートを取得します。同名のノートが複数存在する場合、すべて取得します。
-- **list**: ファイル名で検索します。部分一致での検索が可能です。
+- **list**: ノート名とフォルダ名で検索します。部分一致での検索が可能です。既定では20件を返します。limit 引数には1から200の整数を受け付けます。応答にはマッチした総件数が含まれます。
 
 ## 貢献
 

data/lib/exe.rb

@@ -101,26 +101,34 @@ class ReadTool < MCP::Tool
 end
 
 class ListTool < MCP::Tool
-  description "Search for files with matching names partially."
+  description "Search for notes whose name or containing folder names partially match."
   input_schema(
     properties: {
-      name: { type: "string", description: "Note name to search" }
+      name: { type: "string", description: "Note name to search" },
+      limit: { type: "integer", description: "Number of notes to return. Between 1 and #{ObsidianFetch::MAX_LIST_LIMIT}. Default: #{ObsidianFetch::MAX_LIST_SIZE}." }
     },
     required: ["name"]
   )
 
-  def self.call(name:)
+  def self.call(name:, limit: ObsidianFetch::MAX_LIST_SIZE)
     return MCP::Tool::Response.new([{ type: "text", text: "Name must be a string" }], error: true) unless name.is_a?(String)
-    result = ObsidianFetch.list_notes($manager.vault, name)
+    result = ObsidianFetch.list_notes($manager.vault, name, limit: limit)
     MCP::Tool::Response.new([{ type: "text", text: result.text }], error: result.error)
   end
 end
 
 # MCPサーバーの初期化
+#
+# capabilities を明示的に指定しています。
+# MCP::Server は capabilities を渡さない場合、default_capabilities を使います。
+# default_capabilities には tools だけでなく prompts、resources、logging が含まれるため、
+# リソースを持たないこのサーバーでもクライアントが resources/list を呼び出し、空の一覧が返ってしまいます。
+# https://github.com/modelcontextprotocol/ruby-sdk/blob/v1.8.2/lib/mcp/server.rb
 server = MCP::Server.new(
   name: "obsidian-fetch",
   version: ObsidianFetch::VERSION,
   tools: [ReadTool, ListTool],
+  capabilities: { tools: { listChanged: true } },
 )
 
 # トランスポートを選択してサーバーを起動

data/lib/obsidian_fetch/logic.rb

@@ -8,7 +8,10 @@ module ObsidianFetch
     end
   end
 
+  # list ツールの既定の返却件数
   MAX_LIST_SIZE = 20
+  # list ツールで指定できる返却件数の上限
+  MAX_LIST_LIMIT = 200
 
   # ノート名を正規化する
   # ファイル名に使えない文字については除去しない。aliasで設定されている場合もあるため。
@@ -16,6 +19,10 @@ module ObsidianFetch
     note_name.gsub(/[\[\]\#\^|]/, '')
   end
 
+  PATH_CORRECTION_PREFACE = <<~EOS
+    Presumably a path was specified. The process was automatically renamed and processed.
+  EOS
+
   # --- ツールロジック ---
   def self.read_note(vault, name)
     name = ObsidianFetch.normalize_note_name(name)
@@ -27,47 +34,55 @@ module ObsidianFetch
       fixed_name = File.basename(name, '.md')
       file_pathes = vault.notes[fixed_name]
       if file_pathes.nil?
+        # 完全一致がない場合のみ、大文字小文字の差異を許容した検索をする
+        candidates = case_variant_candidates(vault, fixed_name)
+        return fuzzy_match_response(vault, fixed_name, candidates, PATH_CORRECTION_PREFACE) unless candidates.empty?
+
         # もしも名前で見つからなければ、リンクにも存在しないか確認する
         link_pathes = vault.links_by_file_name[fixed_name]
         if link_pathes.nil?
           return Result.new(text: note_not_found(name), error: true)
         else
           # リンク先のノートが見つかった場合は、prefaceを追加する
-          preface = <<~EOS
-            Presumably a path was specified. The process was automatically renamed and processed.
-          EOS
-          return Result.new(text: list_links(fixed_name, preface, vault), error: true)
+          return Result.new(text: list_links(fixed_name, PATH_CORRECTION_PREFACE, vault), error: true)
         end
       else
         # ノート名が見つかった場合は、prefaceを追加する
-        preface = <<~EOS
-          Presumably a path was specified. The process was automatically renamed and processed.
-        EOS
-        return Result.new(text: open_file(fixed_name, file_pathes, preface, vault))
+        return Result.new(text: PATH_CORRECTION_PREFACE + case_variant_suggestion(vault, fixed_name) + open_file(fixed_name, file_pathes, "", vault))
       end
     end
 
     # 名前のノートが存在しない場合
     if file_pathes.nil?
+      # 完全一致がない場合のみ、大文字小文字の差異を許容した検索をする
+      candidates = case_variant_candidates(vault, name)
+      return fuzzy_match_response(vault, name, candidates, preface) unless candidates.empty?
+
       return Result.new(text: note_not_found(name), error: true) if vault.links_by_file_name[name].nil?
       return Result.new(text: list_links(name, preface, vault), error: true)
     end
 
-    Result.new(text: open_file(name, file_pathes, preface, vault))
+    Result.new(text: case_variant_suggestion(vault, name) + open_file(name, file_pathes, preface, vault))
   end
 
-  def self.list_notes(vault, name)
+  def self.list_notes(vault, name, limit: MAX_LIST_SIZE)
+    unless limit.is_a?(Integer) && limit >= 1 && limit <= MAX_LIST_LIMIT
+      return Result.new(text: <<~EOS, error: true)
+        The limit must be an integer between 1 and #{MAX_LIST_LIMIT}.
+      EOS
+    end
+
     name = ObsidianFetch.normalize_note_name(name)
     split_name = name.split(/[\t \u3000]+/)
     # 空白文字で検索された場合は失敗した旨を返す
-    # 仮に全ノートからランダムなMAX_LIST_SIZEを返してしまうと、LLMが誤って呼び出した場合に偽の関連性を持ってしまうため
+    # 仮に全ノートからランダムに limit 件返してしまうと、LLMが誤って呼び出した場合に偽の関連性を持ってしまうため
     if split_name.empty?
       return Result.new(text: <<~EOS, error: true)
         It cannot be listed in a blank string.
       EOS
     end
-    matched_notes = vault.notes.select do |note_name, _file_pathes|
-      split_name.map { |name_part| note_name.include?(name_part) }.all?
+    matched_notes = vault.notes.filter_map do |note_name, file_pathes|
+      match_note(vault, note_name, file_pathes, split_name)
     end
     # 名前で検索したが見つからない場合
     if matched_notes.empty?
@@ -79,18 +94,103 @@ module ObsidianFetch
       return Result.new(text: <<~EOS, error: true)
         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")}
+        #{sort_case_insensitive(vault.links_by_file_name[name].map { |file_path| File.basename(file_path, '.md') }).map { |note_name| "- #{note_name}" }.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
+    # マッチしたノートの数が limit より多い場合は、優先順位の順に枠を埋める
+    # truncate されるグループは先頭と末尾を出す
+    total = matched_notes.size
+    by_name = matched_notes.count { |entry| entry[:matched_by_name] }
+    tiers = matched_notes.group_by { |entry| entry[:distance] }.keys.sort.map do |distance|
+      matched_notes.select { |entry| entry[:distance] == distance }.sort_by { |entry| [entry[:note_name].downcase, entry[:note_name]] }
+    end
+
+    segments = []
+    remaining = limit
+    tiers.each do |tier|
+      break if remaining.zero?
+
+      if tier.size <= remaining
+        segments << {entries: tier, omitted_after: 0}
+        remaining -= tier.size
+      elsif remaining < 3
+        segments << {entries: tier.first(remaining), omitted_after: tier.size - remaining}
+        remaining = 0
+      else
+        head_size = (remaining * 2) / 3
+        tail_size = remaining - head_size
+        segments << {entries: tier.first(head_size), omitted_after: tier.size - remaining}
+        segments << {entries: tier.last(tail_size), omitted_after: 0}
+        remaining = 0
+      end
+    end
+
+    shown = segments.sum { |segment| segment[:entries].size }
+    preface = "#{total} notes matched '#{name}'"
+    preface += " (#{by_name} by note name, #{total - by_name} by folder name)" if total > by_name
+    preface += ".\n"
+    if shown < total
+      preface += "I will show you #{shown} of them. To see the rest, narrow the search or raise the limit.\n"
     end
-    # マッチした名前のリストで返す
-    list = matched_notes.keys.shuffle.map { |note_name| "- #{note_name}" }.join("\n")
-    Result.new(text: preface + list)
+    preface += "Notes matching '#{name}' are as follows.\n"
+    lines = []
+    segments.each do |segment|
+      lines += segment[:entries].map do |entry|
+        if entry[:matched_by_name]
+          "- #{entry[:note_name]}"
+        else
+          "- #{entry[:note_name]} (#{entry[:display_folder]})"
+        end
+      end
+      lines << "... (#{segment[:omitted_after]} notes omitted) ..." if segment[:omitted_after].positive?
+    end
+    Result.new(text: preface + lines.join("\n") + "\n")
+  end
+
+  # ノート1件について検索語のマッチを判定し、マッチしていれば情報を返す
+  # 距離はファイルからの距離で、ノート名は距離0、直近の親フォルダは距離1、その上が距離2とする
+  # 各語の最も近いマッチ位置のうち、最も遠いものがそのノートの距離になる
+  def self.match_note(vault, note_name, file_pathes, words)
+    lowered_words = words.map(&:downcase)
+    best = nil
+
+    file_pathes.each do |file_path|
+      vault_name, rel_path = relative_path(vault, file_path)
+      folders = rel_path.split('/')[0...-1]
+
+      distances = lowered_words.map do |word|
+        distance = note_name.downcase.include?(word) ? 0 : nil
+        folders.each_with_index do |folder, index|
+          next unless folder.downcase.include?(word)
+          candidate = folders.size - index
+          distance = candidate if distance.nil? || candidate < distance
+        end
+        distance
+      end
+      next if distances.any?(&:nil?)
+
+      display_folder = folders.join('/')
+      display_folder = File.join(vault_name, display_folder) if vault.vault_pathes.size > 1 && vault_name
+
+      entry = {
+        note_name: note_name,
+        distance: distances.max,
+        matched_by_name: distances.max.zero?,
+        display_folder: display_folder,
+      }
+      best = entry if best.nil? || entry[:distance] < best[:distance]
+    end
+
+    best
+  end
+
+  # 保管庫ルートからの相対パスと、その保管庫名を返す
+  def self.relative_path(vault, file_path)
+    vault.vault_pathes.each do |vault_path|
+      pattern = /\A#{Regexp.escape(vault_path)}\/+/
+      return [File.basename(vault_path), file_path.sub(pattern, '')] if file_path.match?(pattern)
+    end
+    [nil, File.basename(file_path)]
   end
 
   # --- ヘルパーメソッド ---
@@ -100,25 +200,62 @@ module ObsidianFetch
     EOS
   end
 
+  # 大文字小文字は揃えて比較し、同値は原名の ASCII 順でタイブレークする
+  def self.sort_case_insensitive(values)
+    values.sort_by { |value| [value.downcase, value] }
+  end
+
+  # 完全一致を除いた、大文字小文字の差異だけのキーをノート名順で返す
+  def self.case_variant_candidates(vault, target)
+    sort_case_insensitive(vault.notes.keys.reject { |note_name| note_name == target }.select { |note_name| note_name.downcase == target.downcase })
+  end
+
+  # 完全一致を読むときに、揺らぎマッチしたノート名のサジェストを組み立てる
+  def self.case_variant_suggestion(vault, target)
+    candidates = case_variant_candidates(vault, target)
+    return "" if candidates.empty?
+
+    if candidates.size == 1
+      "There is also a note with the same name in different capitalization:\n- #{candidates.first}\n\n"
+    else
+      "There are also notes with the same name in different capitalization:\n" +
+        candidates.map { |note_name| "- #{note_name}" }.join("\n") + "\n\n"
+    end
+  end
+
+  # 揺らぎマッチの応答を組み立てる
+  # 候補が1件のときはその内容を読み、複数のときは候補名の一覧を返す
+  def self.fuzzy_match_response(vault, target, candidates, preface)
+    if candidates.size == 1
+      note_name = candidates.first
+      message = "There is no note named '#{target}'. The following note has the same name with different capitalization:\n- #{note_name}\n\n"
+      Result.new(text: preface + message + open_file(note_name, vault.notes[note_name], "", vault), error: false)
+    else
+      message = "There is no note named '#{target}'. The following notes have the same name with different capitalization:\n" +
+        candidates.map { |note_name| "- #{note_name}" }.join("\n") + "\n"
+      Result.new(text: preface + message, error: false)
+    end
+  end
+
   def self.list_links(name, preface, vault)
     <<~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")}
+      #{sort_case_insensitive(vault.links_by_file_name[name].map { |file_path| File.basename(file_path, '.md') }).map { |note_name| "- #{note_name}" }.join("\n")}
     EOS
   end
 
   def self.open_file(name, file_pathes, preface, vault)
     # 複数のファイルがある場合は、---とファイル名で区切って返す
-    result = file_pathes.map do |file_path|
+    result = sort_case_insensitive(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")}
+          #{sort_case_insensitive(vault.links_by_file_path[file_path].map { |linked_path| File.basename(linked_path, '.md') }).map { |note_name| "- #{note_name}" }.join("\n")}
         EOS
       end
       metadata = <<~EOS

data/lib/obsidian_fetch/version.rb

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

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: obsidian_fetch
 version: !ruby/object:Gem::Version
-  version: 1.2.0
+  version: 1.3.0
 platform: ruby
 authors:
 - sou7
@@ -15,14 +15,14 @@ dependencies:
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: 0.14.0
+        version: '1.8'
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: 0.14.0
+        version: '1.8'
 - !ruby/object:Gem::Dependency
   name: rack
   requirement: !ruby/object:Gem::Requirement
@@ -86,7 +86,7 @@ required_ruby_version: !ruby/object:Gem::Requirement
   requirements:
   - - ">="
     - !ruby/object:Gem::Version
-      version: 3.1.0
+      version: 3.3.0
 required_rubygems_version: !ruby/object:Gem::Requirement
   requirements:
   - - ">="