obsidian_fetch 0.1.10 → 1.0.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 5f1f3795373c330483a11d7c66fdb4bf44b7312a6f4065e7aefd230e9a4fe245
-  data.tar.gz: 8cd7c19f1780e3c9f89ca537f26ec5ad711073b7cd8e7ba07ed6a4d015b0b9e4
+  metadata.gz: 02563af73296a2af37e1ea12b6943dad193c5dc77a24ee5d77462d2d846366a2
+  data.tar.gz: fabf0d51658773dc3b708e737116914bde4b55f9e43dda066911c6576f5b38bd
 SHA512:
-  metadata.gz: 0ea95a17289bd2ec4f5d940a947abea3c458febdec89ffb7695e58d2ad4ea5cb3f281194552e56ec6ebc4c67557cf6ca12aafeab9c5aad0e2373a3b7a484ff7d
-  data.tar.gz: 0a089431af584dba6faeafe73b8d86f41ee2dc42bcdd5ef640e56dd65421fb539eaf8107ed4cea5421bbda397103268b234f27c043546a366a4ed9137952f776
+  metadata.gz: 83967477cbd13c96797d9254b755af6f5436a70877344b1353dc48c406e8cd9a0bd8d7a061480a125da53e4f66c7126290295645ade26f47a64ba64d9be15c61
+  data.tar.gz: f2baff1697d33d8fe8c97fef41b9efeac56b0386bcfc623745e1658a1d7ad1fb9e4c1e0a363c171814f156dad0fc3ca61de9f8c469ca3eef6344ba7622a8e29d

data/README.md

@@ -1,20 +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.
-- Support for aliases.
+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

@@ -1,73 +1,4 @@
 # !/usr/bin/env ruby
 # frozen_string_literal: true
 
-require 'obsidian_fetch'
-
-
-name 'obsidian-fetch'
-
-version '0.1.0'
-
-vault_pathes = ARGV
-
-vault = ObsidianFetch::Vault.new(vault_pathes)
-STDERR.puts "Found #{vault.notes.size} notes"
-STDERR.puts "Found #{vault.links_by_file_name.size} links and #{vault.links_by_file_path.size} files linked by notes"
-
-tool 'read' do
-  description <<~EOS
-    Read a note from Obsidian vault.
-    If I find multiple notes with the same name, I will show you all of them.
-  EOS
-  argument :name, String, required: true, description: "Note name to read"
-  call do |args|
-    name = args[:name]
-    # 名前が文字列でない場合
-    next 'Name must be a string' unless name.is_a?(String)
-    vault.tool_read(name)
-  end
-end
-
-tool 'read_multiple' do
-  description <<~EOS
-    Read a notes from Obsidian vault.
-    If I find multiple notes with the same name, I will show you all of them.
-  EOS
-  argument :names, Array, items: String, required: true, description: "Note names to read"
-  call do |args|
-    names = args[:names]
-    # 名前が文字列の配列でない場合
-    next 'Name must be an array of strings' unless names.is_a?(Array) && names.all? { |name| name.is_a?(String) }
-    names.map do |name|
-      vault.tool_read(name)
-    end.join("\n\n---\n\n")
-  end
-end
-
-tool 'list' do
-  description <<~EOS
-    Search for files with matching names partially.
-  EOS
-  argument :name, String, required: true, description: "Note name to search"
-  call do |args|
-    name = args[:name]
-    # 名前が文字列でない場合
-    next 'Name must be a string' unless name.is_a?(String)
-    vault.tool_list(name)
-  end
-end
-
-tool 'list_multiple' do
-  description <<~EOS
-    Search for files with matching names partially.
-  EOS
-  argument :names, Array, items: String, required: true, description: "Note names to search"
-  call do |args|
-    names = args[:names]
-    # 名前が文字列の配列でない場合
-    next 'Name must be an array of strings' unless names.is_a?(Array) && names.all? { |name| name.is_a?(String) }
-    names.map do |name|
-      vault.tool_list(name)
-    end.join("\n\n---\n\n")
-  end
-end
+require 'exe'

data/lib/exe.rb

@@ -0,0 +1,59 @@
+require 'mcp'
+require 'obsidian_fetch'
+
+# Obsidian Vaultの初期化
+vault_paths = ARGV
+$vault = ObsidianFetch::Vault.new(vault_paths)
+STDERR.puts "Found #{$vault.notes.size} notes"
+STDERR.puts "Found #{$vault.links_by_file_name.size} links and #{$vault.links_by_file_path.size} files linked by notes"
+
+# readツールの定義
+class ReadTool < MCP::Tool
+  description "Read a note from Obsidian vault. If multiple notes with the same name are found, all will be shown."
+  input_schema(
+    properties: {
+      name: { type: "string", description: "Note name to read" }
+    },
+    required: ["name"]
+  )
+
+  def self.call(name:)
+    # 名前が文字列でない場合
+    return MCP::Tool::Response.new([{ type: "text", text: "Name must be a string" }]) unless name.is_a?(String)
+
+    # Vaultからノートを読み取る
+    result = $vault.tool_read(name)
+    MCP::Tool::Response.new([{ type: "text", text: result }])
+  end
+end
+
+# listツールの定義
+class ListTool < MCP::Tool
+  description "Search for files with matching names partially."
+  input_schema(
+    properties: {
+      name: { type: "string", description: "Note name to search" }
+    },
+    required: ["name"]
+  )
+
+  def self.call(name:)
+    # 名前が文字列でない場合
+    return MCP::Tool::Response.new([{ type: "text", text: "Name must be a string" }]) unless name.is_a?(String)
+
+    # Vaultからノートを検索
+    result = $vault.tool_list(name)
+    MCP::Tool::Response.new([{ type: "text", text: result }])
+  end
+end
+
+# MCPサーバーの初期化
+server = MCP::Server.new(
+  name: "obsidian-fetch",
+  version: "0.1.0",
+  tools: [ReadTool, ListTool],
+)
+
+# Stdioトランスポートを使用してサーバーを起動
+transport = MCP::Server::Transports::StdioTransport.new(server)
+transport.open

data/lib/obsidian_fetch/version.rb

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

data/lib/obsidian_fetch.rb

@@ -2,7 +2,6 @@
 
 require 'yaml'
 require 'date'
-require 'mcp'
 
 require_relative "obsidian_fetch/version"
 
@@ -82,6 +81,7 @@ module ObsidianFetch
         # もしリンクが設定されていれば、linksに追加する
         # [[link]]と[[link|displayname]]の場合
         # linkに.mdが付いている場合、付いていない場合両方を考慮する
+        # TODO : linkにディレクトリ名が着くことがあるので、それを除去する
         content.scan(/\[\[(.*?)(?:\|.*)?\]\]/) do |match|
           link_name = match[0]
           link_name = link_name.sub(/\.md$/, '') # .mdを削除
@@ -133,19 +133,60 @@ module ObsidianFetch
     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
+
       # 名前のノートが存在しない場合
       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
+        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
+
+    private def note_not_found name
+      return <<~EOS
+        Note not found: #{name}
+      EOS
+    end
+
+    private def list_links name, preface
+      return <<~EOS
+        #{preface}
+        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
+
+    private def open_file name, file_pathes, preface
       # 複数のファイルがある場合は、---とファイル名で区切って返す
-      file_pathes.map do |file_path|
+      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?
           ""
@@ -155,16 +196,16 @@ module ObsidianFetch
             #{(@links_by_file_path[file_path] || []).shuffle.map { |file_path| "- #{File.basename(file_path, '.md')}" }.join("\n")}
           EOS
         end
-        preface = <<~EOS
+        metadata = <<~EOS
           The contents of the note '#{name}' is as follows.
           #{link_notes}
           ---
-    
         EOS
-        preface + content
+        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)

metadata

@@ -1,30 +1,28 @@
 --- !ruby/object:Gem::Specification
 name: obsidian_fetch
 version: !ruby/object:Gem::Version
-  version: 0.1.10
+  version: 1.0.0
 platform: ruby
 authors:
 - sou7
-autorequire:
 bindir: exe
 cert_chain: []
-date: 2025-04-29 00:00:00.000000000 Z
+date: 1980-01-02 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
-  name: mcp-rb
+  name: mcp
   requirement: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: 0.3.2
+        version: 0.2.0
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: 0.3.2
-description:
+        version: 0.2.0
 email:
 - soukouki0@yahoo.co.jp
 executables:
@@ -37,6 +35,7 @@ files:
 - README.md
 - Rakefile
 - exe/obsidian_fetch
+- lib/exe.rb
 - lib/obsidian_fetch.rb
 - lib/obsidian_fetch/version.rb
 - sig/obsidian_fetch.rbs
@@ -47,7 +46,6 @@ metadata:
   homepage_uri: https://ob.sou7.io/2025-04/week17/obsidian_fetch
   source_code_uri: https://github.com/soukouki/obsidian_fetch
   changelog_uri: https://github.com/soukouki/obsidian_fetch/blob/main/CHANGELOG.md
-post_install_message:
 rdoc_options: []
 require_paths:
 - lib
@@ -62,8 +60,8 @@ required_rubygems_version: !ruby/object:Gem::Requirement
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
-rubygems_version: 3.5.22
-signing_key:
+rubygems_version: 3.6.7
 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: []