obsidian_fetch 0.1.11 → 1.1.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 996b482b6dcf13de18f54917084aa60f9470d6903596d449fb5a0a5c7c2c51cd
-  data.tar.gz: 5d76e2811f3f5e18de3a217fe570d168156e531ec20b86fbecbb74722ec82b58
+  metadata.gz: 101c9a34b8abc3a5cb6ea08f4a8a2f969e91717ba47799e1b4a803dc9d3edc12
+  data.tar.gz: dc12e468bc254caab30bbb2982f5d981e24ef997bc39d6f880c441b6ec0583f1
 SHA512:
-  metadata.gz: 187c1f785491440b2f221ce29fd253cc57b421d31c458016c5577ba906f256fbbf510c9ae5de101084db49bf0d754b84466834ff7b500b4c96e72dc95383964b
-  data.tar.gz: 2eabd6144aa231db4900e563e315b7be74cc3cc7460f52a8f604c00d8108fe91fec9eaf334fb64e53fc109c19eca3d1ab34316883dc1718a38eb35903dcf9db2
+  metadata.gz: cc00c3e03ddd24d4990ee58a4bdfacfaca1a67f791a9ce7e011c114a751bd28b9bf8f9aadb16baa574a0497b4ffeaaed7978d2298cfcc08f85f8be5828881f9c
+  data.tar.gz: 06a0930f90be578c44d5437b9e8dd04a6b0ed7ae08f38ab8c8e4ddaa842bc4bf32cd8f34ea6c15c45073511caf625a465c2e613cde3d13242a8124f248c99914

data/README.md

@@ -1,5 +1,7 @@
 # ObsidianFetch
 
+> Languages: [日本語](README_ja.md)
+
 MCP servers focused on fetching and presenting information from Obsidian vaults.
 
 The existing MCP server has the following drawbacks:
@@ -23,10 +25,31 @@ gem install obsidian_fetch
 
 ## Usage
 
+### Stdio Transport (default)
+
 ```bash
 obsidian_fetch /path/to/your/vault
 ```
 
+### Streamable HTTP Transport
+
+To run the server as an HTTP server:
+
+```bash
+obsidian_fetch /path/to/your/vault --transport streamable-http
+```
+
+By default, the server listens on `http://localhost:9292`. You can customize the port:
+
+```bash
+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.
+
 ## Contributing
 
 Bug reports and pull requests are welcome on GitHub at https://github.com/soukouki/obsidian_fetch.

data/README_ja.md

@@ -0,0 +1,63 @@
+# ObsidianFetch
+
+> Languages: [English version](README.md)
+
+ObsidianのVaultから必要な情報をサクッと取得するためのMCPサーバーです。
+
+## 概要
+
+既存のMCPサーバーを使っていると、こんな悩みはありませんでしたか？
+
+- コマンドが多すぎて、ローカルLLMだと読み込みに時間がかかる
+- 特定のノートを探してほしいのに、LLMがうまくパスを辿ってくれない
+- ツール設定が複雑で、LLMが正しく呼び出せない
+
+特にローカルGPUでLLMを動かしている場合、これらの問題がボトルネックになります。
+
+そこで、「ノートのリスト取得」と「中身の読み込み」というシンプルな機能に特化したサーバーを開発しました。
+
+さらに、使い勝手を良くするために以下の機能を追加しています：
+
+- **リンクの自動修正**: `[[リンク名]]` のように括弧付きで検索したとき、不要な文字を自動で消して正しくリンクを解決します。
+- **バックリンク対応**: ノートの中身だけでなく、「どのノートから参照されているか」というバックリンクも一緒に取得します。これでLLMが知識のつながりをより正確に把握できます。
+
+## インストール
+
+```bash
+gem install obsidian_fetch
+```
+
+## 使用方法
+
+### Stdio Transport（デフォルト）
+
+```bash
+obsidian_fetch /path/to/your/vault
+```
+
+### Streamable HTTP Transport
+
+HTTPサーバーとして実行する場合は、以下のコマンドを使用します。
+
+```bash
+obsidian_fetch /path/to/your/vault --transport streamable-http
+```
+
+デフォルトでは `http://localhost:9292` で接続できます。ポート番号は以下のようにカスタマイズ可能です。
+
+```bash
+obsidian_fetch /path/to/your/vault --transport streamable-http --port 3000
+```
+
+## ツール
+
+- **read**: Obsidian Vaultからノートを取得します。同名のノートが複数存在する場合、すべて取得します。
+- **list**: ファイル名で検索します。部分一致での検索が可能です。
+
+## 貢献
+
+バグ報告やプルリクエストは、GitHubリポジトリ（https://github.com/soukouki/obsidian_fetch）にてお待ちしております。
+
+## ライセンス
+
+このジェムは [MITライセンス](https://opensource.org/licenses/MIT) の下で公開されています。

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,167 @@
+# frozen_string_literal: true
+
+require 'mcp'
+require 'obsidian_fetch'
+
+# Parse arguments with validation
+VALID_TRANSPORTS = %w[stdio streamable-http].freeze
+DEFAULT_TRANSPORT = 'stdio'
+DEFAULT_PORT = 9292
+
+transport_type = DEFAULT_TRANSPORT
+port = DEFAULT_PORT
+vault_paths = []
+
+i = 0
+while i < ARGV.length
+  arg = ARGV[i]
+  case arg
+  when '--help', '-h'
+    puts "Usage: obsidian_fetch [vault_path] [--transport {stdio|streamable-http}] [--port PORT]"
+    puts ""
+    puts "Options:"
+    puts "  --transport {stdio|streamable-http}  Transport type (default: stdio)"
+    puts "    stdio:            Standard I/O transport for local MCP clients"
+    puts "    streamable-http:  Streamable HTTP transport (MCP spec latest)"
+    puts ""
+    puts "  --port PORT              HTTP port for streamable-http transport (default: 9292)"
+    puts ""
+    puts "Examples:"
+    puts "  obsidian_fetch /path/to/vault"
+    puts "  obsidian_fetch /path/to/vault --transport streamable-http"
+    puts "  obsidian_fetch /path/to/vault --transport streamable-http --port 3000"
+    exit 0
+  when '--transport'
+    if i + 1 >= ARGV.length
+      STDERR.puts "Error: --transport requires an argument (stdio or sse)"
+      exit 1
+    end
+    transport_type = ARGV[i + 1]
+    unless VALID_TRANSPORTS.include?(transport_type)
+      STDERR.puts "Error: Invalid transport '#{transport_type}'. Must be one of: #{VALID_TRANSPORTS.join(', ')}"
+      exit 1
+    end
+    i += 2 # Skip the next argument (transport type)
+  when '--port'
+    if i + 1 >= ARGV.length
+      STDERR.puts "Error: --port requires a numeric argument"
+      exit 1
+    end
+    port_val = ARGV[i + 1]
+    unless port_val =~ /^\d+$/
+      STDERR.puts "Error: --port must be a positive integer"
+      exit 1
+    end
+    port = port_val.to_i
+    unless port > 0 && port <= 65535
+      STDERR.puts "Error: --port must be between 1 and 65535"
+      exit 1
+    end
+    i += 2 # Skip the next argument (port value)
+  else
+    vault_paths << arg
+    i += 1
+  end
+end
+
+# Validate vault paths
+if vault_paths.empty?
+  STDERR.puts "Error: At least one vault path is required"
+  STDERR.puts "Run with --help for usage information"
+  exit 1
+end
+
+vault_paths.each do |path|
+  unless File.directory?(path)
+    STDERR.puts "Error: Vault path '#{path}' does not exist or is not a directory"
+    exit 1
+  end
+end
+
+# Obsidian Vaultの初期化
+$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"
+STDERR.puts "Transport type: #{transport_type}"
+STDERR.puts "Port: #{port}" if transport_type == 'streamable-http'
+
+# 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],
+)
+
+# トランスポートを選択してサーバーを起動
+case transport_type
+when 'streamable-http'
+  require 'puma'
+  require 'rack'
+
+  # Streamable HTTP トランスポートを使用してサーバーを起動
+  transport = MCP::Server::Transports::StreamableHTTPTransport.new(server, stateless: true)
+
+  # PumaでRack appとして起動
+  $stdout.sync = true
+  $stderr.sync = true
+
+  server_obj = Puma::Server.new(transport) do
+    max_threads 16
+    min_threads 1
+  end
+  server_obj.add_tcp_listener "127.0.0.1", port
+
+  STDERR.puts "Streamable HTTP transport started on http://localhost:#{port}"
+  STDERR.puts "Press Ctrl+C to stop"
+
+  # サーバーを起動してメインプロセスをブロックする
+  server_thread = server_obj.run
+  server_thread.join
+when 'stdio'
+  # Stdioトランスポートを使用してサーバーを起動
+  transport = MCP::Server::Transports::StdioTransport.new(server)
+  transport.open
+else
+  STDERR.puts "Unknown transport type: #{transport_type}. Supported: stdio, sse"
+  exit 1
+end

data/lib/obsidian_fetch/version.rb

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

data/lib/obsidian_fetch.rb

@@ -2,7 +2,6 @@
 
 require 'yaml'
 require 'date'
-require 'mcp'
 
 require_relative "obsidian_fetch/version"
 
@@ -62,7 +61,7 @@ module ObsidianFetch
             puts "YAML syntax error in #{file_path}: #{e.message}"
             next
           end
-          (frontmatter&.[](:aliases) || []).each do |alias_name|
+          Array(frontmatter&.[](:aliases) || []).each do |alias_name|
             alias_name = Vault.normalize_note_name(alias_name)
             @notes[alias_name] ||= []
             @notes[alias_name] << file_path
@@ -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を削除

metadata

@@ -1,30 +1,56 @@
 --- !ruby/object:Gem::Specification
 name: obsidian_fetch
 version: !ruby/object:Gem::Version
-  version: 0.1.11
+  version: 1.1.0
 platform: ruby
 authors:
 - sou7
-autorequire:
 bindir: exe
 cert_chain: []
-date: 2025-04-30 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.14.0
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: 0.3.2
-description:
+        version: 0.14.0
+- !ruby/object:Gem::Dependency
+  name: rack
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '2.0'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '2.0'
+- !ruby/object:Gem::Dependency
+  name: puma
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '5.0'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '5.0'
 email:
 - soukouki0@yahoo.co.jp
 executables:
@@ -35,8 +61,10 @@ files:
 - CHANGELOG.md
 - LICENSE.txt
 - README.md
+- README_ja.md
 - Rakefile
 - exe/obsidian_fetch
+- lib/exe.rb
 - lib/obsidian_fetch.rb
 - lib/obsidian_fetch/version.rb
 - sig/obsidian_fetch.rbs
@@ -47,7 +75,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 +89,7 @@ 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.9
 specification_version: 4
 summary: MCP servers focused on fetching and presenting information from Obsidian
   vaults