libtmux-mcp 0.1.0.alpha.3 → 0.1.1

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: af3b345cc9efd2ed4fcb1c384d8ee9a0e8f14b0da9052eedafb5e88b285a2501
-  data.tar.gz: f6c4f2647b58a02730b17ab57190f7cfc5ef2927c923961608d2a192d9f1b077
+  metadata.gz: 892583808fe4a27248b270071193932a4f7b36fb5eb592358c4ceb2ac24f296c
+  data.tar.gz: b45a1a838d2831cc34a1fab2c9a4d36780cae5594050dd9a3063dbb2f5e79067
 SHA512:
-  metadata.gz: 62dddd73fc6080af123ef9b4b5aeb5dca20c72d8798232d69df61777f3e1aaa9b44db30d1853949e2e5d266d063b6827ed2b3f4feb4950072418d2283739bba2
-  data.tar.gz: 37bffa621af62f041a08dffa029d2f060874686983982e70a1906343fd2755bfc6b81daefeb1e2914f99a53a38ba7d88c1b90edb1982f3f48349396bdb1a91e9
+  metadata.gz: 3d0d730cb95acf640cbaf2ddf1702c917558662a9427fc0c5b9d17bca81321998563efa7eed740140e7813d779f0cfc777b3ec6977528c59562fae957e6d17f1
+  data.tar.gz: 05eb4ecc928723328ee886877821e89ea5f05654dfe31c1f0652825dd582c4978e4442e7876fd37d265681aa3a92b1facd14210b62860d9d1088895feeb87f6d

data/README.md

@@ -20,6 +20,9 @@ tool at a time.
 [Guides](https://libtmux.org/en/ruby/latest/mcp/guides/) ·
 [RubyGems](https://rubygems.org/gems/libtmux-mcp)
 
+[![libtmux.org](https://img.shields.io/badge/docs-libtmux.org-0b7285)](https://libtmux.org/en/ruby/latest/mcp/)
+[![libtmux-mcp](https://img.shields.io/gem/v/libtmux-mcp?label=libtmux-mcp)](https://rubygems.org/gems/libtmux-mcp)
+
 </div>
 
 Part of [libtmux for Ruby](https://github.com/libtmux/libtmux-ruby#readme).
@@ -40,11 +43,11 @@ transport.
 
 ## Quick start
 
-Install the alpha and its `libtmux-mcp` executable. It needs Ruby 3.3 or newer
+Install the gem and its `libtmux-mcp` executable. It needs Ruby 3.3 or newer
 and tmux 3.3a or newer:
 
 ```console
-$ gem install libtmux-mcp --pre
+$ gem install libtmux-mcp
 ```
 
 The server borrows a tmux server that is already running. Start one on a
@@ -122,6 +125,15 @@ $ libtmux-mcp \
     --socket-name agent
 ```
 
+- With neither flag, the server borrows the socket in `LIBTMUX_SOCKET_PATH`,
+  else the name in `LIBTMUX_SOCKET`, else the server `TMUX` names when it runs
+  inside tmux, else tmux's default socket. When both variables are set, the
+  path wins, and an empty variable counts as unset. A flag ignores both
+  variables, and the two flags are refused together.
+- The server never starts a tmux server. When none answers at the socket it
+  chose, it exits with status 1.
+- Started from a tmux pane with no flag or variable, the server drives that
+  pane's server. Pass `--socket-name` to give an agent a server of its own.
 - EOF retires the clients the server owns and leaves the daemon running.
 - `--endpoint` sets the public alias in discovery and resource URIs, and
   defaults to `local`.
@@ -334,7 +346,9 @@ pass the invitation to [`accept_shell`][mcp-application-accept_shell].
 
 ## Support and status
 
-**Alpha.** APIs may change between releases.
+Releases are numbered `0.1.N`, and each release increments `N`. The API is not
+settled: any release may change or remove exported identifiers, and the
+changelog marks each break. Pin an exact version to avoid one.
 
 - **Ruby 3.3 or newer.** The gem depends on `libtmux` and `libtmux-async` at
   the same version, the `mcp` SDK 1.5, `digest` and `optparse`.
@@ -348,8 +362,10 @@ pass the invitation to [`accept_shell`][mcp-application-accept_shell].
   client.
 - **Linux, including WSL, and macOS.** The core
   [compatibility workflow][compat] runs Ruby 3.3, 3.4 and 4.0 with tmux 3.3a
-  through 3.8 on Ubuntu 24.04. macOS is supported on a best-effort basis, and
-  CI coverage for it is highly limited.
+  through 3.8 on Ubuntu 24.04. A push and a pull request run the oldest and
+  newest of those releases, 3.3a and 3.8, and a release runs all of them. macOS
+  is supported on a best-effort basis, and CI coverage for it is highly
+  limited.
 
 ## Documentation
 

data/lib/libtmux/mcp/cli.rb

@@ -6,12 +6,12 @@ require "optparse"
 module LibTmux
   module MCP
     class CLI
-      def self.run(arguments, input: $stdin, out: $stdout, err: $stderr)
-        new(arguments, input, out, err).run
+      def self.run(arguments, input: $stdin, out: $stdout, err: $stderr, environment: ENV)
+        new(arguments, input, out, err, environment).run
       end
 
-      def initialize(arguments, input, output, error)
-        @arguments, @input, @output, @error = arguments.dup, input, output, error
+      def initialize(arguments, input, output, error, environment = ENV)
+        @arguments, @input, @output, @error, @environment = arguments.dup, input, output, error, environment
         @options = {endpoint_name: "local", executable: "tmux", tools: Catalog::READ_ONLY.dup,
           timeout: 5.0, concurrency: 4, max_requests: 32, max_frame_bytes: 1 << 20,
           max_output_bytes: 1 << 22, max_response_bytes: 1 << 20,
@@ -27,8 +27,7 @@ module LibTmux
           return 0
         end
         validate_arguments
-        endpoint = Endpoint.new(socket_path: @options[:socket_path], socket_name: @options[:socket_name],
-          executable: @options.fetch(:executable))
+        endpoint = build_endpoint
         Async do |task|
           begin
             serve(endpoint, task)
@@ -44,7 +43,7 @@ module LibTmux
           end
         end.wait
       rescue OptionParser::ParseError, ArgumentError => error
-        report("Invalid arguments; use --help for supported options.", 2, failure: error)
+        report(@invalid_endpoint || "Invalid arguments; use --help for supported options.", 2, failure: error)
       rescue Interrupt, LibTmux::Cancelled => error
         report("MCP interrupted; dispatched effects may remain.", 130, failure: error)
       rescue StandardError => error
@@ -53,6 +52,25 @@ module LibTmux
 
       private
 
+      # --socket and --socket-name win; otherwise the core reads the variables,
+      # TMUX and tmux's default.
+      def build_endpoint
+        socket_path = @options[:socket_path]
+        socket_path = expand_socket(socket_path) unless socket_path.nil? || socket_path.empty?
+        Endpoint.new(socket_path: socket_path, socket_name: @options[:socket_name],
+          executable: @options.fetch(:executable), environment: @environment)
+      rescue ArgumentError => error
+        @invalid_endpoint = "Invalid arguments: #{error.message}."
+        raise
+      end
+
+      # File.expand_path puts the user it cannot find in its message.
+      def expand_socket(socket)
+        File.expand_path(socket)
+      rescue ArgumentError
+        raise ArgumentError, "--socket cannot be expanded to a path; its leading ~ names no home directory"
+      end
+
       def serve(endpoint, task)
         Server.open(endpoint: endpoint) do |server|
           LibTmux::Async.open(server: server, parent: task) do |scope|
@@ -185,9 +203,12 @@ module LibTmux
 
       def parser
         @parser ||= OptionParser.new do |options|
-          options.banner = "Usage: libtmux-mcp (--socket PATH | --socket-name NAME) [options]"
-          options.on("--socket PATH", "Borrow this existing tmux Unix socket") { |value| @options[:socket_path] = value }
-          options.on("--socket-name NAME", "Borrow this explicit tmux socket name") { |value| @options[:socket_name] = value }
+          options.banner = "Usage: libtmux-mcp [--socket PATH | --socket-name NAME] [options]"
+          options.on("--socket PATH", "Borrow the tmux server at this Unix socket",
+            "Default: LIBTMUX_SOCKET_PATH, then LIBTMUX_SOCKET, then the",
+            "server TMUX names, then tmux's default socket") { |value| @options[:socket_path] = value }
+          options.on("--socket-name NAME", "Borrow the tmux server with this socket name",
+            "Not with --socket") { |value| @options[:socket_name] = value }
           options.on("--endpoint NAME", "Public endpoint alias (default: local)") { |value| @options[:endpoint_name] = value }
           options.on("--tmux EXECUTABLE", "Resolve and pin this tmux executable at startup") { |value| @options[:executable] = value }
           options.on("--enable-tool NAME", "Enable one additional tool; repeat as needed") { |value| @options.fetch(:tools) << value }
@@ -211,7 +232,7 @@ module LibTmux
 
       def validate_arguments
         raise ArgumentError unless @arguments.empty?
-        raise ArgumentError unless [@options[:socket_path], @options[:socket_name]].compact.length == 1
+        raise ArgumentError if @options[:socket_path] && @options[:socket_name]
         raise ArgumentError unless @options.fetch(:tools).all? { |name| Catalog::NAMES.include?(name) }
         raise ArgumentError unless /\A[A-Za-z0-9][A-Za-z0-9_.-]{0,127}\z/.match?(@options.fetch(:endpoint_name))
         raise ArgumentError unless @options.fetch(:timeout).finite? && @options.fetch(:timeout).positive?

data/lib/libtmux/mcp/version.rb

@@ -2,6 +2,6 @@
 
 module LibTmux
   module MCP
-    VERSION = "0.1.0.alpha.3"
+    VERSION = "0.1.1"
   end
 end

data/sig/libtmux-mcp.rbs

@@ -10,7 +10,7 @@ module LibTmux
     class CLI
       private def self.new: (*untyped, **untyped) -> instance
       def run: () -> Integer
-      def self.run: (Array[String], ?input: IO, ?out: untyped, ?err: untyped) -> Integer
+      def self.run: (Array[String], ?input: IO, ?out: untyped, ?err: untyped, ?environment: untyped) -> Integer
     end
     class Application
       attr_reader tools: Array[untyped]

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: libtmux-mcp
 version: !ruby/object:Gem::Version
-  version: 0.1.0.alpha.3
+  version: 0.1.1
 platform: ruby
 authors:
 - libtmux contributors
@@ -15,28 +15,28 @@ dependencies:
     requirements:
     - - '='
       - !ruby/object:Gem::Version
-        version: 0.1.0.alpha.3
+        version: 0.1.1
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - '='
       - !ruby/object:Gem::Version
-        version: 0.1.0.alpha.3
+        version: 0.1.1
 - !ruby/object:Gem::Dependency
   name: libtmux-async
   requirement: !ruby/object:Gem::Requirement
     requirements:
     - - '='
       - !ruby/object:Gem::Version
-        version: 0.1.0.alpha.3
+        version: 0.1.1
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - '='
       - !ruby/object:Gem::Version
-        version: 0.1.0.alpha.3
+        version: 0.1.1
 - !ruby/object:Gem::Dependency
   name: mcp
   requirement: !ruby/object:Gem::Requirement
@@ -118,7 +118,7 @@ licenses:
 - MIT
 metadata:
   source_code_uri: https://github.com/libtmux/libtmux-ruby
-  documentation_uri: https://libtmux.org/en/ruby/v0.1.0.alpha.3/mcp/
+  documentation_uri: https://libtmux.org/en/ruby/v0.1.1/mcp/
 rdoc_options: []
 require_paths:
 - lib