claude-agent-sdk 0.7.2 → 0.7.3

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 1bb953f4036b0f107f4afe0bfb8d89281bb3d496cf15f89a6c5607e7b3b5e210
-  data.tar.gz: 84081e6b7aa1ebbe580b0e900f4142829278c3a458dc706807e4d141a0af70ff
+  metadata.gz: d17d03fa867e2779de155d6fba8a86fbc9edbc5662157ca3e21606016c81fb17
+  data.tar.gz: 949787994cd58eb5be72b8834a519a704697c61ecbfff9ca1d6f4e1fe921b18f
 SHA512:
-  metadata.gz: eda57b17c43f2efa673e31cba432db7022af999e8c8de82065bc4e21c13325a07480cc632004226847d383881916605218332b129f0524d2b3a1c0b291dee3d1
-  data.tar.gz: e5e9f25bb361ecaaf84a9972e55d94ed1eb18e5ae50c7abc8831f9a3a01c36e510835a8d253f71c0ba0df7f88de04ca024125ac4627a4274c84629e56ba3f57c
+  metadata.gz: a99fdb7b2dcab7e0286763abfb1f6d0277423a7ef2198a040ef8c76a8959907009ebc21f6523c35ecff1409a66fd8c636648d1f594aaa481119ed3598eb1b06e
+  data.tar.gz: 8e3e7e26487dcfe993534d3d1b7f695ba5009ad18e9d173c9e1e0f1353ec54565905f3e74e81a39eb5789aa2df008536a2a5a191095e7d8604f36abd27bb6583

data/CHANGELOG.md

@@ -5,11 +5,30 @@ All notable changes to this project will be documented in this file.
 The format is based on [Keep a Changelog](https://keepachangelog.com/en/1.0.0/),
 and this project adheres to [Semantic Versioning](https://semver.org/spec/v2.0.0.html).
 
+## [0.7.3] - 2026-02-26
+
+### Fixed
+- **String-keyed JSON schema crash:** Libraries like [RubyLLM](https://github.com/crmne/ruby_llm) that deep-stringify schema keys (e.g., `{ 'type' => 'object', 'properties' => { ... } }`) were misidentified as simple type-mapping schemas, causing each top-level key to be treated as a parameter name instead of passing the schema through. Now both symbol-keyed and string-keyed schemas are detected and normalized correctly. (PR #9 by [@iuhoay](https://github.com/iuhoay))
+- **Shallow key symbolization:** `convert_schema` used `transform_keys` (shallow) which left nested property keys as strings, breaking downstream `MCP::Tool::InputSchema` construction. Now uses deep symbolization recursively.
+- **Guard ordering crash:** `convert_schema` and `convert_input_schema` accessed `schema[:type]` before the `schema.is_a?(Hash)` guard, which would raise `NoMethodError` on `nil` input.
+- **Schema detection tightened:** Pre-built schema detection now requires `type == 'object'` and `properties.is_a?(Hash)`, preventing false positives when a simple schema happens to have parameters named `type` and `properties`.
+
+### Added
+- `ClaudeAgentSDK.deep_symbolize_keys` utility method for recursive hash key symbolization
+
 ## [0.7.2] - 2026-02-21
 
 ### Fixed
+- **Unknown content block crash:** Unrecognized content block types (e.g., `document` blocks from PDF reading) now return `UnknownBlock` instead of raising `MessageParseError`, aligning with the Python SDK's forward-compatible design
+- **Unknown message type crash:** Unrecognized message types now return `nil` (skipped by callers) instead of raising
 - **Empty input schema crash:** Tools with no parameters (`input_schema: {}`) caused `MCP::Tool::InputSchema` validation failure (`required` array must have at least 1 item per JSON Schema draft-04). Now omits `required` when empty.
-- **RuboCop offense:** Removed redundant `else` clause in `MessageParser.parse`
+
+### Added
+- `UnknownBlock` type that preserves raw data for unrecognized content block types
+
+### Changed
+- **Breaking (minor):** `MessageParser.parse` no longer raises `MessageParseError` for unknown message types — returns `nil` instead. If you were rescuing `MessageParseError` to handle unknown types, check for `nil` return values instead.
+- **Breaking (minor):** `MessageParser.parse_content_block` no longer raises `MessageParseError` for unknown content block types — returns `UnknownBlock` instead. Content block iteration using `is_a?` filtering (e.g., `block.is_a?(TextBlock)`) is unaffected.
 
 ## [0.7.1] - 2026-02-21
 

data/README.md

@@ -39,7 +39,7 @@ Add this line to your application's Gemfile:
 gem 'claude-agent-sdk', github: 'ya-luotao/claude-agent-sdk-ruby'
 
 # Or use a stable version from RubyGems
-gem 'claude-agent-sdk', '~> 0.7.2'
+gem 'claude-agent-sdk', '~> 0.7.3'
 ```
 
 And then execute:
@@ -282,6 +282,26 @@ Async do
 end.wait
 ```
 
+### Pre-built JSON Schemas
+
+If your schemas come from another library (e.g., [RubyLLM](https://github.com/crmne/ruby_llm)) that deep-stringifies keys, the SDK handles them transparently — both symbol-keyed and string-keyed schemas are accepted and normalized:
+
+```ruby
+# Symbol keys (standard Ruby)
+tool = ClaudeAgentSDK.create_tool('save', 'Save a fact', {
+  type: 'object',
+  properties: { fact: { type: 'string' } },
+  required: ['fact']
+}) { |args| { content: [{ type: 'text', text: "Saved: #{args[:fact]}" }] } }
+
+# String keys (e.g., from RubyLLM or JSON.parse)
+tool = ClaudeAgentSDK.create_tool('save', 'Save a fact', {
+  'type' => 'object',
+  'properties' => { 'fact' => { 'type' => 'string' } },
+  'required' => ['fact']
+}) { |args| { content: [{ type: 'text', text: "Saved: #{args[:fact]}" }] } }
+```
+
 ### Benefits Over External MCP Servers
 
 - **No subprocess management** - Runs in the same process as your application
@@ -978,7 +998,7 @@ end
 
 ```ruby
 # Union type of all content blocks
-ContentBlock = TextBlock | ThinkingBlock | ToolUseBlock | ToolResultBlock
+ContentBlock = TextBlock | ThinkingBlock | ToolUseBlock | ToolResultBlock | UnknownBlock
 ```
 
 #### TextBlock
@@ -1026,6 +1046,17 @@ class ToolResultBlock
 end
 ```
 
+#### UnknownBlock
+
+Generic content block for types the SDK doesn't explicitly handle (e.g., `document` for PDFs, `image` for inline images). Preserves the raw data for forward compatibility with newer CLI versions.
+
+```ruby
+class UnknownBlock
+  attr_accessor :type,  # String — the original block type (e.g., "document")
+                :data   # Hash — the full raw block hash
+end
+```
+
 ### Error Types
 
 ```ruby

data/lib/claude_agent_sdk/sdk_mcp_server.rb

@@ -3,6 +3,15 @@
 require 'mcp'
 
 module ClaudeAgentSDK
+  # Recursively convert all hash keys to symbols
+  def self.deep_symbolize_keys(obj)
+    case obj
+    when Hash then obj.transform_keys(&:to_sym).transform_values { |v| deep_symbolize_keys(v) }
+    when Array then obj.map { |v| deep_symbolize_keys(v) }
+    else obj
+    end
+  end
+
   # SDK MCP Server - wraps official MCP::Server with block-based API
   #
   # Unlike external MCP servers that run as separate processes, SDK MCP servers
@@ -191,9 +200,12 @@ module ClaudeAgentSDK
             private
 
             def convert_schema(schema)
-              # If it's already a proper JSON schema, return it
-              if schema.is_a?(Hash) && schema[:type] && schema[:properties]
-                return schema
+              # If it's already a proper JSON schema (symbol or string keys), normalize
+              # to symbol keys so downstream code (schema[:properties]) works uniformly.
+              if schema.is_a?(Hash)
+                type_val = schema[:type] || schema['type']
+                props_val = schema[:properties] || schema['properties']
+                return ClaudeAgentSDK.deep_symbolize_keys(schema) if type_val == 'object' && props_val.is_a?(Hash)
               end
 
               # Simple schema: hash mapping parameter names to types
@@ -318,9 +330,12 @@ module ClaudeAgentSDK
     end
 
     def convert_input_schema(schema)
-      # If it's already a proper JSON schema, return it
-      if schema.is_a?(Hash) && schema[:type] && schema[:properties]
-        return schema
+      # If it's already a proper JSON schema (symbol or string keys), normalize
+      # to symbol keys for consistent output.
+      if schema.is_a?(Hash)
+        type_val = schema[:type] || schema['type']
+        props_val = schema[:properties] || schema['properties']
+        return ClaudeAgentSDK.deep_symbolize_keys(schema) if type_val == 'object' && props_val.is_a?(Hash)
       end
 
       # Simple schema: hash mapping parameter names to types

data/lib/claude_agent_sdk/version.rb

@@ -1,5 +1,5 @@
 # frozen_string_literal: true
 
 module ClaudeAgentSDK
-  VERSION = '0.7.2'
+  VERSION = '0.7.3'
 end

metadata

@@ -1,13 +1,13 @@
 --- !ruby/object:Gem::Specification
 name: claude-agent-sdk
 version: !ruby/object:Gem::Version
-  version: 0.7.2
+  version: 0.7.3
 platform: ruby
 authors:
 - Community Contributors
 bindir: bin
 cert_chain: []
-date: 2026-02-21 00:00:00.000000000 Z
+date: 2026-02-25 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: async