obsidian_fetch 1.0.0 → 1.1.1

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 02563af73296a2af37e1ea12b6943dad193c5dc77a24ee5d77462d2d846366a2
-  data.tar.gz: fabf0d51658773dc3b708e737116914bde4b55f9e43dda066911c6576f5b38bd
+  metadata.gz: '0992b2a2f014ca5b769ea7fda3489b865084234a8291cec96feacb51ab4c1f0b'
+  data.tar.gz: 5cdd32d72283570de361c2b50cf0dd3c2bf8222fff30e17397848f6e0419c3bd
 SHA512:
-  metadata.gz: 83967477cbd13c96797d9254b755af6f5436a70877344b1353dc48c406e8cd9a0bd8d7a061480a125da53e4f66c7126290295645ade26f47a64ba64d9be15c61
-  data.tar.gz: f2baff1697d33d8fe8c97fef41b9efeac56b0386bcfc623745e1658a1d7ad1fb9e4c1e0a363c171814f156dad0fc3ca61de9f8c469ca3eef6344ba7622a8e29d
+  metadata.gz: 4f4649c707d4a8d816d1fb5c884608b1e497c5b0e3945a6f69233c689172b6334cb772c1b7ccada4737c11b848806795e897943090ac072e18643c8afe68f7a3
+  data.tar.gz: 45043168da41509700e97f1670182eab192057ddf9986628c72846d88dda875cb0a83fcbae4e6471151681a40920e5bbe742756eca54077d8fdc3ee44521c989

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/lib/exe.rb

@@ -1,11 +1,89 @@
+# 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_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"
+STDERR.puts "Transport type: #{transport_type}"
+STDERR.puts "Port: #{port}" if transport_type == 'streamable-http'
 
 # readツールの定義
 class ReadTool < MCP::Tool
@@ -54,6 +132,40 @@ server = MCP::Server.new(
   tools: [ReadTool, ListTool],
 )
 
-# Stdioトランスポートを使用してサーバーを起動
-transport = MCP::Server::Transports::StdioTransport.new(server)
-transport.open
+# トランスポートを選択してサーバーを起動
+case transport_type
+when 'streamable-http'
+  require 'puma'
+  require 'rack'
+
+  # Streamable HTTP トランスポートを使用してサーバーを起動
+  transport = MCP::Server::Transports::StreamableHTTPTransport.new(
+    server,
+    stateless: true,
+    enable_json_response: 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 = "1.0.0"
+  VERSION = "1.1.1"
 end

data/lib/obsidian_fetch.rb

@@ -61,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

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: obsidian_fetch
 version: !ruby/object:Gem::Version
-  version: 1.0.0
+  version: 1.1.1
 platform: ruby
 authors:
 - sou7
@@ -15,14 +15,42 @@ dependencies:
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: 0.2.0
+        version: 0.14.0
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: 0.2.0
+        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:
@@ -33,6 +61,7 @@ files:
 - CHANGELOG.md
 - LICENSE.txt
 - README.md
+- README_ja.md
 - Rakefile
 - exe/obsidian_fetch
 - lib/exe.rb
@@ -60,7 +89,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
-rubygems_version: 3.6.7
+rubygems_version: 3.6.9
 specification_version: 4
 summary: MCP servers focused on fetching and presenting information from Obsidian
   vaults