obsidian_fetch 0.1.2

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA256:
+  metadata.gz: c9de6573e2f1754f39f00139ab39a74f292cb43bd838e2524e68f0e1bd1d7283
+  data.tar.gz: 4f661ae683d1e7c140a8fba607c1f3258e6bc1677d0b9e274c7e67bd0753f03b
+SHA512:
+  metadata.gz: 0b0f956739d3eba9ebb28bd28786169f164e9aced9bdff57f9dde7769dc34de7b30e3e60ce18689bcaa90e3fe907f76b94266069894fa24868c6dd0e5f1d917b
+  data.tar.gz: eb680c31c93783621717e69b28dac56ed1843a3838d73a74871c65c8b130bba544c3049bffcce2ad25b796f21a04734ed6e9e45376efde4b09ebbe9d9dbec77a

data/CHANGELOG.md

@@ -0,0 +1,5 @@
+## [Unreleased]
+
+## [0.1.0] - 2025-04-27
+
+- Initial release

data/LICENSE.txt

@@ -0,0 +1,21 @@
+The MIT License (MIT)
+
+Copyright (c) 2025 soukouki
+
+Permission is hereby granted, free of charge, to any person obtaining a copy
+of this software and associated documentation files (the "Software"), to deal
+in the Software without restriction, including without limitation the rights
+to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
+copies of the Software, and to permit persons to whom the Software is
+furnished to do so, subject to the following conditions:
+
+The above copyright notice and this permission notice shall be included in
+all copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
+IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
+FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
+AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
+LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
+OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN
+THE SOFTWARE.

data/README.md

@@ -0,0 +1,39 @@
+# ObsidianFetch
+
+TODO: Delete this and the text below, and describe your gem
+
+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.
+
+## Installation
+
+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.
+
+Install the gem and add to the application's Gemfile by executing:
+
+```bash
+bundle add UPDATE_WITH_YOUR_GEM_NAME_IMMEDIATELY_AFTER_RELEASE_TO_RUBYGEMS_ORG
+```
+
+If bundler is not being used to manage dependencies, install the gem by executing:
+
+```bash
+gem install UPDATE_WITH_YOUR_GEM_NAME_IMMEDIATELY_AFTER_RELEASE_TO_RUBYGEMS_ORG
+```
+
+## 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.
+
+## License
+
+The gem is available as open source under the terms of the [MIT License](https://opensource.org/licenses/MIT).

data/Rakefile

@@ -0,0 +1,4 @@
+# frozen_string_literal: true
+
+require "bundler/gem_tasks"
+task default: %i[]

data/exe/obsidian_fetch

@@ -0,0 +1,73 @@
+# !/usr/bin/env ruby
+# frozen_string_literal: true
+
+require 'obsidian_fetch'
+
+
+name 'obsidian-fetch'
+
+version '0.1.0'
+
+vault_pathes = ARGV
+
+vault = 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)
+    tool_read(vault, 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|
+      tool_read(vault, 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)
+    tool_list(vault, 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|
+      tool_list(vault, name)
+    end.join("\n\n---\n\n")
+  end
+end

data/lib/obsidian_fetch/version.rb

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

data/lib/obsidian_fetch.rb

@@ -0,0 +1,199 @@
+# frozen_string_literal: true
+
+require 'yaml'
+require 'date'
+require 'mcp'
+
+require_relative "obsidian_fetch/version"
+
+module ObsidianFetch
+  class Error < StandardError; end
+  
+  class Vault
+    attr_reader :notes, :links_by_file_path, :links_by_file_name
+  
+    def initialize vault_pathes
+      @vault_pathes = vault_pathes
+  
+      # key: note_name, value: [file_pathes]
+      @notes = {}
+  
+      # key: file_path, value: [file_pathes]
+      @links_by_file_path = {}
+  
+      # ノートが見つからなかった場合に被リンクを表示するためのハッシュ
+      # key: note_name, value: [file_pathes]
+      @links_by_file_name = {}
+  
+      collect_pathes()
+      collect_notes()
+      collect_links()
+    end
+  
+    private
+  
+    def collect_pathes
+      @all_pathes = @vault_pathes.flat_map do |vault_path|
+        Dir.glob("#{vault_path}/**/*.md")
+      end
+    end
+  
+    # ノート名を正規化する
+    # ファイル名に使えない文字については除去しない。aliasで設定されている場合もあるため。
+    def self.normalize_note_name(note_name)
+      # ノート名を小文字に変換し、リンクに使えない文字を除去する
+      note_name.gsub(/[\[\]#\^\|]/, '')
+    end
+  
+    def collect_notes
+      # ノート名を整理するための処理
+      @all_pathes.each do |file_path|
+        file_name = File.basename(file_path, '.md')
+        file_name = Vault.normalize_note_name(file_name)
+        @notes[file_name] ||= []
+        @notes[file_name] << file_path
+        content = open(file_path) { |f| f.read.force_encoding('UTF-8') }
+        # もしaliasが設定されていれば、それも追加する
+        frontmatter_str = content.match(/\A---(.*?\n)---/m)&.[](1)
+        if frontmatter_str
+          begin
+            frontmatter = YAML.safe_load(frontmatter_str, symbolize_names: true, aliases: true, permitted_classes: [Date])
+          rescue Psych::SyntaxError => e
+            puts "YAML syntax error in #{file_path}: #{e.message}"
+            next
+          end
+          (frontmatter&.[](:aliases) || []).each do |alias_name|
+            alias_name = Vault.normalize_note_name(alias_name)
+            @notes[alias_name] ||= []
+            @notes[alias_name] << file_path
+          end
+        end
+      end
+      @notes.each{|_name, file_pathes| file_pathes.uniq!}
+    end
+  
+    def collect_links
+      # リンクを整理するための処理
+      # リンクを整理するためにノート名のリストを使用するため、ここで処理する
+      @all_pathes.each do |file_path|
+        file_name = File.basename(file_path, '.md')
+        file_name = Vault.normalize_note_name(file_name)
+        content = open(file_path) { |f| f.read.force_encoding('UTF-8') }
+        # もしリンクが設定されていれば、linksに追加する
+        # [[link]]と[[link|displayname]]の場合
+        # linkに.mdが付いている場合、付いていない場合両方を考慮する
+        content.scan(/\[\[(.*?)(?:\|.*)?\]\]/) do |match|
+          link_name = match[0]
+          link_name = link_name.sub(/\.md$/, '') # .mdを削除
+          # #、^以降の文字列を削除
+          link_name = link_name.sub(/#.*$/, '')
+          link_name = Vault.normalize_note_name(link_name)
+          next if link_name == file_name # 自分自身をリンクしている場合は無視する
+          @links_by_file_name[link_name] ||= []
+          @links_by_file_name[link_name] << file_path
+          # 同名のノートがある場合に、どこにリンクしているかを処理するのは結構難しい
+          # ここでは簡単のため、同名のノートがある場合はすべてのファイルをリンク先として追加する
+          # ただし、aliasは除外する
+          linked_candidates = (@notes[link_name] || []).filter{|path| path.include?(link_name + '.md') }
+          linked_candidates.each do |linked_candidate|
+            @links_by_file_path[linked_candidate] ||= []
+            @links_by_file_path[linked_candidate] << file_path
+          end
+        end
+        # [displayname](path)の場合
+        # pathの末尾に.mdが付いている場合、付いていない場合両方を考慮する
+        content.scan(/\[(.*?)\]\((?!\[\[)(.*?)(?<!\]\])\)/) do |match|
+          path = match[1]
+          # `(.+)://`から始まる場合は除外する
+          next if path =~ /^[a-z]+:\/\// # 外部リンク
+          # #、^以降の文字列を削除
+          path = path.sub(/#.*$/, '')
+          path = path.sub(/\.md$/, '') # .mdを削除
+          link_name = File.basename(path)
+          link_name = Vault.normalize_note_name(link_name)
+          @links_by_file_name[link_name] ||= []
+          @links_by_file_name[link_name] << file_path
+          # Obsidianはかなり賢くて、リンク先のファイルが無い場合には、その配下のファイルを探してくれる
+          # 今回の実装ではそこまで考慮せず、pathを信用する
+          path_from_vault = File.join(File.dirname(file_path), path) + '.md'
+          @links_by_file_path[path_from_vault] ||= []
+          @links_by_file_path[path_from_vault] << file_path
+        end
+      end
+      @links_by_file_name.each do |_file_name, file_pathes|
+        file_pathes.uniq!
+      end
+      @links_by_file_path.each do |_file_path, file_pathes|
+        file_pathes.uniq!
+      end
+    end
+  end
+
+  def 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
+      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 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
+    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
+end

data/sig/obsidian_fetch.rbs

@@ -0,0 +1,4 @@
+module ObsidianFetch
+  VERSION: String
+  # See the writing guide of rbs: https://github.com/ruby/rbs#guides
+end

metadata

@@ -0,0 +1,69 @@
+--- !ruby/object:Gem::Specification
+name: obsidian_fetch
+version: !ruby/object:Gem::Version
+  version: 0.1.2
+platform: ruby
+authors:
+- sou7
+autorequire:
+bindir: exe
+cert_chain: []
+date: 2025-04-26 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: mcp-rb
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 0.3.3
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 0.3.3
+description:
+email:
+- soukouki0@yahoo.co.jp
+executables:
+- obsidian_fetch
+extensions: []
+extra_rdoc_files: []
+files:
+- CHANGELOG.md
+- LICENSE.txt
+- README.md
+- Rakefile
+- exe/obsidian_fetch
+- lib/obsidian_fetch.rb
+- lib/obsidian_fetch/version.rb
+- sig/obsidian_fetch.rbs
+homepage: https://ob.sou7.io/2025-04/week17/obsidian_fetch
+licenses:
+- MIT
+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
+required_ruby_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: 3.1.0
+required_rubygems_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '0'
+requirements: []
+rubygems_version: 3.5.22
+signing_key:
+specification_version: 4
+summary: MCP servers specialising in retrieving information from Obsidian vaults.
+test_files: []