openai 0.18.1 → 0.20.0

data/rbi/openai/models/responses/tool.rbi

@@ -18,10 +18,357 @@ module OpenAI
               OpenAI::Responses::Tool::ImageGeneration,
               OpenAI::Responses::Tool::LocalShell,
               OpenAI::Responses::CustomTool,
+              OpenAI::Responses::Tool::WebSearchTool,
               OpenAI::Responses::WebSearchTool
             )
           end
 
+        class WebSearchTool < OpenAI::Internal::Type::BaseModel
+          OrHash =
+            T.type_alias do
+              T.any(
+                OpenAI::Responses::Tool::WebSearchTool,
+                OpenAI::Internal::AnyHash
+              )
+            end
+
+          # The type of the web search tool. One of `web_search` or `web_search_2025_08_26`.
+          sig do
+            returns(OpenAI::Responses::Tool::WebSearchTool::Type::OrSymbol)
+          end
+          attr_accessor :type
+
+          # Filters for the search.
+          sig do
+            returns(T.nilable(OpenAI::Responses::Tool::WebSearchTool::Filters))
+          end
+          attr_reader :filters
+
+          sig do
+            params(
+              filters:
+                T.nilable(
+                  OpenAI::Responses::Tool::WebSearchTool::Filters::OrHash
+                )
+            ).void
+          end
+          attr_writer :filters
+
+          # High level guidance for the amount of context window space to use for the
+          # search. One of `low`, `medium`, or `high`. `medium` is the default.
+          sig do
+            returns(
+              T.nilable(
+                OpenAI::Responses::Tool::WebSearchTool::SearchContextSize::OrSymbol
+              )
+            )
+          end
+          attr_reader :search_context_size
+
+          sig do
+            params(
+              search_context_size:
+                OpenAI::Responses::Tool::WebSearchTool::SearchContextSize::OrSymbol
+            ).void
+          end
+          attr_writer :search_context_size
+
+          # The approximate location of the user.
+          sig do
+            returns(
+              T.nilable(OpenAI::Responses::Tool::WebSearchTool::UserLocation)
+            )
+          end
+          attr_reader :user_location
+
+          sig do
+            params(
+              user_location:
+                T.nilable(
+                  OpenAI::Responses::Tool::WebSearchTool::UserLocation::OrHash
+                )
+            ).void
+          end
+          attr_writer :user_location
+
+          # Search the Internet for sources related to the prompt. Learn more about the
+          # [web search tool](https://platform.openai.com/docs/guides/tools-web-search).
+          sig do
+            params(
+              type: OpenAI::Responses::Tool::WebSearchTool::Type::OrSymbol,
+              filters:
+                T.nilable(
+                  OpenAI::Responses::Tool::WebSearchTool::Filters::OrHash
+                ),
+              search_context_size:
+                OpenAI::Responses::Tool::WebSearchTool::SearchContextSize::OrSymbol,
+              user_location:
+                T.nilable(
+                  OpenAI::Responses::Tool::WebSearchTool::UserLocation::OrHash
+                )
+            ).returns(T.attached_class)
+          end
+          def self.new(
+            # The type of the web search tool. One of `web_search` or `web_search_2025_08_26`.
+            type:,
+            # Filters for the search.
+            filters: nil,
+            # High level guidance for the amount of context window space to use for the
+            # search. One of `low`, `medium`, or `high`. `medium` is the default.
+            search_context_size: nil,
+            # The approximate location of the user.
+            user_location: nil
+          )
+          end
+
+          sig do
+            override.returns(
+              {
+                type: OpenAI::Responses::Tool::WebSearchTool::Type::OrSymbol,
+                filters:
+                  T.nilable(OpenAI::Responses::Tool::WebSearchTool::Filters),
+                search_context_size:
+                  OpenAI::Responses::Tool::WebSearchTool::SearchContextSize::OrSymbol,
+                user_location:
+                  T.nilable(
+                    OpenAI::Responses::Tool::WebSearchTool::UserLocation
+                  )
+              }
+            )
+          end
+          def to_hash
+          end
+
+          # The type of the web search tool. One of `web_search` or `web_search_2025_08_26`.
+          module Type
+            extend OpenAI::Internal::Type::Enum
+
+            TaggedSymbol =
+              T.type_alias do
+                T.all(Symbol, OpenAI::Responses::Tool::WebSearchTool::Type)
+              end
+            OrSymbol = T.type_alias { T.any(Symbol, String) }
+
+            WEB_SEARCH =
+              T.let(
+                :web_search,
+                OpenAI::Responses::Tool::WebSearchTool::Type::TaggedSymbol
+              )
+            WEB_SEARCH_2025_08_26 =
+              T.let(
+                :web_search_2025_08_26,
+                OpenAI::Responses::Tool::WebSearchTool::Type::TaggedSymbol
+              )
+
+            sig do
+              override.returns(
+                T::Array[
+                  OpenAI::Responses::Tool::WebSearchTool::Type::TaggedSymbol
+                ]
+              )
+            end
+            def self.values
+            end
+          end
+
+          class Filters < OpenAI::Internal::Type::BaseModel
+            OrHash =
+              T.type_alias do
+                T.any(
+                  OpenAI::Responses::Tool::WebSearchTool::Filters,
+                  OpenAI::Internal::AnyHash
+                )
+              end
+
+            # Allowed domains for the search. If not provided, all domains are allowed.
+            # Subdomains of the provided domains are allowed as well.
+            #
+            # Example: `["pubmed.ncbi.nlm.nih.gov"]`
+            sig { returns(T.nilable(T::Array[String])) }
+            attr_accessor :allowed_domains
+
+            # Filters for the search.
+            sig do
+              params(allowed_domains: T.nilable(T::Array[String])).returns(
+                T.attached_class
+              )
+            end
+            def self.new(
+              # Allowed domains for the search. If not provided, all domains are allowed.
+              # Subdomains of the provided domains are allowed as well.
+              #
+              # Example: `["pubmed.ncbi.nlm.nih.gov"]`
+              allowed_domains: nil
+            )
+            end
+
+            sig do
+              override.returns({ allowed_domains: T.nilable(T::Array[String]) })
+            end
+            def to_hash
+            end
+          end
+
+          # High level guidance for the amount of context window space to use for the
+          # search. One of `low`, `medium`, or `high`. `medium` is the default.
+          module SearchContextSize
+            extend OpenAI::Internal::Type::Enum
+
+            TaggedSymbol =
+              T.type_alias do
+                T.all(
+                  Symbol,
+                  OpenAI::Responses::Tool::WebSearchTool::SearchContextSize
+                )
+              end
+            OrSymbol = T.type_alias { T.any(Symbol, String) }
+
+            LOW =
+              T.let(
+                :low,
+                OpenAI::Responses::Tool::WebSearchTool::SearchContextSize::TaggedSymbol
+              )
+            MEDIUM =
+              T.let(
+                :medium,
+                OpenAI::Responses::Tool::WebSearchTool::SearchContextSize::TaggedSymbol
+              )
+            HIGH =
+              T.let(
+                :high,
+                OpenAI::Responses::Tool::WebSearchTool::SearchContextSize::TaggedSymbol
+              )
+
+            sig do
+              override.returns(
+                T::Array[
+                  OpenAI::Responses::Tool::WebSearchTool::SearchContextSize::TaggedSymbol
+                ]
+              )
+            end
+            def self.values
+            end
+          end
+
+          class UserLocation < OpenAI::Internal::Type::BaseModel
+            OrHash =
+              T.type_alias do
+                T.any(
+                  OpenAI::Responses::Tool::WebSearchTool::UserLocation,
+                  OpenAI::Internal::AnyHash
+                )
+              end
+
+            # Free text input for the city of the user, e.g. `San Francisco`.
+            sig { returns(T.nilable(String)) }
+            attr_accessor :city
+
+            # The two-letter [ISO country code](https://en.wikipedia.org/wiki/ISO_3166-1) of
+            # the user, e.g. `US`.
+            sig { returns(T.nilable(String)) }
+            attr_accessor :country
+
+            # Free text input for the region of the user, e.g. `California`.
+            sig { returns(T.nilable(String)) }
+            attr_accessor :region
+
+            # The [IANA timezone](https://timeapi.io/documentation/iana-timezones) of the
+            # user, e.g. `America/Los_Angeles`.
+            sig { returns(T.nilable(String)) }
+            attr_accessor :timezone
+
+            # The type of location approximation. Always `approximate`.
+            sig do
+              returns(
+                T.nilable(
+                  OpenAI::Responses::Tool::WebSearchTool::UserLocation::Type::OrSymbol
+                )
+              )
+            end
+            attr_reader :type
+
+            sig do
+              params(
+                type:
+                  OpenAI::Responses::Tool::WebSearchTool::UserLocation::Type::OrSymbol
+              ).void
+            end
+            attr_writer :type
+
+            # The approximate location of the user.
+            sig do
+              params(
+                city: T.nilable(String),
+                country: T.nilable(String),
+                region: T.nilable(String),
+                timezone: T.nilable(String),
+                type:
+                  OpenAI::Responses::Tool::WebSearchTool::UserLocation::Type::OrSymbol
+              ).returns(T.attached_class)
+            end
+            def self.new(
+              # Free text input for the city of the user, e.g. `San Francisco`.
+              city: nil,
+              # The two-letter [ISO country code](https://en.wikipedia.org/wiki/ISO_3166-1) of
+              # the user, e.g. `US`.
+              country: nil,
+              # Free text input for the region of the user, e.g. `California`.
+              region: nil,
+              # The [IANA timezone](https://timeapi.io/documentation/iana-timezones) of the
+              # user, e.g. `America/Los_Angeles`.
+              timezone: nil,
+              # The type of location approximation. Always `approximate`.
+              type: nil
+            )
+            end
+
+            sig do
+              override.returns(
+                {
+                  city: T.nilable(String),
+                  country: T.nilable(String),
+                  region: T.nilable(String),
+                  timezone: T.nilable(String),
+                  type:
+                    OpenAI::Responses::Tool::WebSearchTool::UserLocation::Type::OrSymbol
+                }
+              )
+            end
+            def to_hash
+            end
+
+            # The type of location approximation. Always `approximate`.
+            module Type
+              extend OpenAI::Internal::Type::Enum
+
+              TaggedSymbol =
+                T.type_alias do
+                  T.all(
+                    Symbol,
+                    OpenAI::Responses::Tool::WebSearchTool::UserLocation::Type
+                  )
+                end
+              OrSymbol = T.type_alias { T.any(Symbol, String) }
+
+              APPROXIMATE =
+                T.let(
+                  :approximate,
+                  OpenAI::Responses::Tool::WebSearchTool::UserLocation::Type::TaggedSymbol
+                )
+
+              sig do
+                override.returns(
+                  T::Array[
+                    OpenAI::Responses::Tool::WebSearchTool::UserLocation::Type::TaggedSymbol
+                  ]
+                )
+              end
+              def self.values
+              end
+            end
+          end
+        end
+
         class Mcp < OpenAI::Internal::Type::BaseModel
           OrHash =
             T.type_alias do
@@ -32,10 +379,6 @@ module OpenAI
           sig { returns(String) }
           attr_accessor :server_label
 
-          # The URL for the MCP server.
-          sig { returns(String) }
-          attr_accessor :server_url
-
           # The type of the MCP tool. Always `mcp`.
           sig { returns(Symbol) }
           attr_accessor :type
@@ -46,13 +389,51 @@ module OpenAI
               T.nilable(
                 T.any(
                   T::Array[String],
-                  OpenAI::Responses::Tool::Mcp::AllowedTools::McpAllowedToolsFilter
+                  OpenAI::Responses::Tool::Mcp::AllowedTools::McpToolFilter
                 )
               )
             )
           end
           attr_accessor :allowed_tools
 
+          # An OAuth access token that can be used with a remote MCP server, either with a
+          # custom MCP server URL or a service connector. Your application must handle the
+          # OAuth authorization flow and provide the token here.
+          sig { returns(T.nilable(String)) }
+          attr_reader :authorization
+
+          sig { params(authorization: String).void }
+          attr_writer :authorization
+
+          # Identifier for service connectors, like those available in ChatGPT. One of
+          # `server_url` or `connector_id` must be provided. Learn more about service
+          # connectors
+          # [here](https://platform.openai.com/docs/guides/tools-remote-mcp#connectors).
+          #
+          # Currently supported `connector_id` values are:
+          #
+          # - Dropbox: `connector_dropbox`
+          # - Gmail: `connector_gmail`
+          # - Google Calendar: `connector_googlecalendar`
+          # - Google Drive: `connector_googledrive`
+          # - Microsoft Teams: `connector_microsoftteams`
+          # - Outlook Calendar: `connector_outlookcalendar`
+          # - Outlook Email: `connector_outlookemail`
+          # - SharePoint: `connector_sharepoint`
+          sig do
+            returns(
+              T.nilable(OpenAI::Responses::Tool::Mcp::ConnectorID::OrSymbol)
+            )
+          end
+          attr_reader :connector_id
+
+          sig do
+            params(
+              connector_id: OpenAI::Responses::Tool::Mcp::ConnectorID::OrSymbol
+            ).void
+          end
+          attr_writer :connector_id
+
           # Optional HTTP headers to send to the MCP server. Use for authentication or other
           # purposes.
           sig { returns(T.nilable(T::Hash[Symbol, String])) }
@@ -78,20 +459,29 @@ module OpenAI
           sig { params(server_description: String).void }
           attr_writer :server_description
 
+          # The URL for the MCP server. One of `server_url` or `connector_id` must be
+          # provided.
+          sig { returns(T.nilable(String)) }
+          attr_reader :server_url
+
+          sig { params(server_url: String).void }
+          attr_writer :server_url
+
           # Give the model access to additional tools via remote Model Context Protocol
           # (MCP) servers.
           # [Learn more about MCP](https://platform.openai.com/docs/guides/tools-remote-mcp).
           sig do
             params(
               server_label: String,
-              server_url: String,
               allowed_tools:
                 T.nilable(
                   T.any(
                     T::Array[String],
-                    OpenAI::Responses::Tool::Mcp::AllowedTools::McpAllowedToolsFilter::OrHash
+                    OpenAI::Responses::Tool::Mcp::AllowedTools::McpToolFilter::OrHash
                   )
                 ),
+              authorization: String,
+              connector_id: OpenAI::Responses::Tool::Mcp::ConnectorID::OrSymbol,
               headers: T.nilable(T::Hash[Symbol, String]),
               require_approval:
                 T.nilable(
@@ -101,16 +491,35 @@ module OpenAI
                   )
                 ),
               server_description: String,
+              server_url: String,
               type: Symbol
             ).returns(T.attached_class)
           end
           def self.new(
             # A label for this MCP server, used to identify it in tool calls.
             server_label:,
-            # The URL for the MCP server.
-            server_url:,
             # List of allowed tool names or a filter object.
             allowed_tools: nil,
+            # An OAuth access token that can be used with a remote MCP server, either with a
+            # custom MCP server URL or a service connector. Your application must handle the
+            # OAuth authorization flow and provide the token here.
+            authorization: nil,
+            # Identifier for service connectors, like those available in ChatGPT. One of
+            # `server_url` or `connector_id` must be provided. Learn more about service
+            # connectors
+            # [here](https://platform.openai.com/docs/guides/tools-remote-mcp#connectors).
+            #
+            # Currently supported `connector_id` values are:
+            #
+            # - Dropbox: `connector_dropbox`
+            # - Gmail: `connector_gmail`
+            # - Google Calendar: `connector_googlecalendar`
+            # - Google Drive: `connector_googledrive`
+            # - Microsoft Teams: `connector_microsoftteams`
+            # - Outlook Calendar: `connector_outlookcalendar`
+            # - Outlook Email: `connector_outlookemail`
+            # - SharePoint: `connector_sharepoint`
+            connector_id: nil,
             # Optional HTTP headers to send to the MCP server. Use for authentication or other
             # purposes.
             headers: nil,
@@ -118,6 +527,9 @@ module OpenAI
             require_approval: nil,
             # Optional description of the MCP server, used to provide more context.
             server_description: nil,
+            # The URL for the MCP server. One of `server_url` or `connector_id` must be
+            # provided.
+            server_url: nil,
             # The type of the MCP tool. Always `mcp`.
             type: :mcp
           )
@@ -127,15 +539,17 @@ module OpenAI
             override.returns(
               {
                 server_label: String,
-                server_url: String,
                 type: Symbol,
                 allowed_tools:
                   T.nilable(
                     T.any(
                       T::Array[String],
-                      OpenAI::Responses::Tool::Mcp::AllowedTools::McpAllowedToolsFilter
+                      OpenAI::Responses::Tool::Mcp::AllowedTools::McpToolFilter
                     )
                   ),
+                authorization: String,
+                connector_id:
+                  OpenAI::Responses::Tool::Mcp::ConnectorID::OrSymbol,
                 headers: T.nilable(T::Hash[Symbol, String]),
                 require_approval:
                   T.nilable(
@@ -144,7 +558,8 @@ module OpenAI
                       OpenAI::Responses::Tool::Mcp::RequireApproval::McpToolApprovalSetting::OrSymbol
                     )
                   ),
-                server_description: String
+                server_description: String,
+                server_url: String
               }
             )
           end
@@ -159,19 +574,29 @@ module OpenAI
               T.type_alias do
                 T.any(
                   T::Array[String],
-                  OpenAI::Responses::Tool::Mcp::AllowedTools::McpAllowedToolsFilter
+                  OpenAI::Responses::Tool::Mcp::AllowedTools::McpToolFilter
                 )
               end
 
-            class McpAllowedToolsFilter < OpenAI::Internal::Type::BaseModel
+            class McpToolFilter < OpenAI::Internal::Type::BaseModel
               OrHash =
                 T.type_alias do
                   T.any(
-                    OpenAI::Responses::Tool::Mcp::AllowedTools::McpAllowedToolsFilter,
+                    OpenAI::Responses::Tool::Mcp::AllowedTools::McpToolFilter,
                     OpenAI::Internal::AnyHash
                   )
                 end
 
+              # Indicates whether or not a tool modifies data or is read-only. If an MCP server
+              # is
+              # [annotated with `readOnlyHint`](https://modelcontextprotocol.io/specification/2025-06-18/schema#toolannotations-readonlyhint),
+              # it will match this filter.
+              sig { returns(T.nilable(T::Boolean)) }
+              attr_reader :read_only
+
+              sig { params(read_only: T::Boolean).void }
+              attr_writer :read_only
+
               # List of allowed tool names.
               sig { returns(T.nilable(T::Array[String])) }
               attr_reader :tool_names
@@ -181,15 +606,27 @@ module OpenAI
 
               # A filter object to specify which tools are allowed.
               sig do
-                params(tool_names: T::Array[String]).returns(T.attached_class)
+                params(
+                  read_only: T::Boolean,
+                  tool_names: T::Array[String]
+                ).returns(T.attached_class)
               end
               def self.new(
+                # Indicates whether or not a tool modifies data or is read-only. If an MCP server
+                # is
+                # [annotated with `readOnlyHint`](https://modelcontextprotocol.io/specification/2025-06-18/schema#toolannotations-readonlyhint),
+                # it will match this filter.
+                read_only: nil,
                 # List of allowed tool names.
                 tool_names: nil
               )
               end
 
-              sig { override.returns({ tool_names: T::Array[String] }) }
+              sig do
+                override.returns(
+                  { read_only: T::Boolean, tool_names: T::Array[String] }
+                )
+              end
               def to_hash
               end
             end
@@ -209,6 +646,82 @@ module OpenAI
               )
           end
 
+          # Identifier for service connectors, like those available in ChatGPT. One of
+          # `server_url` or `connector_id` must be provided. Learn more about service
+          # connectors
+          # [here](https://platform.openai.com/docs/guides/tools-remote-mcp#connectors).
+          #
+          # Currently supported `connector_id` values are:
+          #
+          # - Dropbox: `connector_dropbox`
+          # - Gmail: `connector_gmail`
+          # - Google Calendar: `connector_googlecalendar`
+          # - Google Drive: `connector_googledrive`
+          # - Microsoft Teams: `connector_microsoftteams`
+          # - Outlook Calendar: `connector_outlookcalendar`
+          # - Outlook Email: `connector_outlookemail`
+          # - SharePoint: `connector_sharepoint`
+          module ConnectorID
+            extend OpenAI::Internal::Type::Enum
+
+            TaggedSymbol =
+              T.type_alias do
+                T.all(Symbol, OpenAI::Responses::Tool::Mcp::ConnectorID)
+              end
+            OrSymbol = T.type_alias { T.any(Symbol, String) }
+
+            CONNECTOR_DROPBOX =
+              T.let(
+                :connector_dropbox,
+                OpenAI::Responses::Tool::Mcp::ConnectorID::TaggedSymbol
+              )
+            CONNECTOR_GMAIL =
+              T.let(
+                :connector_gmail,
+                OpenAI::Responses::Tool::Mcp::ConnectorID::TaggedSymbol
+              )
+            CONNECTOR_GOOGLECALENDAR =
+              T.let(
+                :connector_googlecalendar,
+                OpenAI::Responses::Tool::Mcp::ConnectorID::TaggedSymbol
+              )
+            CONNECTOR_GOOGLEDRIVE =
+              T.let(
+                :connector_googledrive,
+                OpenAI::Responses::Tool::Mcp::ConnectorID::TaggedSymbol
+              )
+            CONNECTOR_MICROSOFTTEAMS =
+              T.let(
+                :connector_microsoftteams,
+                OpenAI::Responses::Tool::Mcp::ConnectorID::TaggedSymbol
+              )
+            CONNECTOR_OUTLOOKCALENDAR =
+              T.let(
+                :connector_outlookcalendar,
+                OpenAI::Responses::Tool::Mcp::ConnectorID::TaggedSymbol
+              )
+            CONNECTOR_OUTLOOKEMAIL =
+              T.let(
+                :connector_outlookemail,
+                OpenAI::Responses::Tool::Mcp::ConnectorID::TaggedSymbol
+              )
+            CONNECTOR_SHAREPOINT =
+              T.let(
+                :connector_sharepoint,
+                OpenAI::Responses::Tool::Mcp::ConnectorID::TaggedSymbol
+              )
+
+            sig do
+              override.returns(
+                T::Array[
+                  OpenAI::Responses::Tool::Mcp::ConnectorID::TaggedSymbol
+                ]
+              )
+            end
+            def self.values
+            end
+          end
+
           # Specify which of the MCP server's tools require approval.
           module RequireApproval
             extend OpenAI::Internal::Type::Union
@@ -230,7 +743,7 @@ module OpenAI
                   )
                 end
 
-              # A list of tools that always require approval.
+              # A filter object to specify which tools are allowed.
               sig do
                 returns(
                   T.nilable(
@@ -248,7 +761,7 @@ module OpenAI
               end
               attr_writer :always
 
-              # A list of tools that never require approval.
+              # A filter object to specify which tools are allowed.
               sig do
                 returns(
                   T.nilable(
@@ -266,6 +779,8 @@ module OpenAI
               end
               attr_writer :never
 
+              # Specify which of the MCP server's tools require approval. Can be `always`,
+              # `never`, or a filter object associated with tools that require approval.
               sig do
                 params(
                   always:
@@ -275,9 +790,9 @@ module OpenAI
                 ).returns(T.attached_class)
               end
               def self.new(
-                # A list of tools that always require approval.
+                # A filter object to specify which tools are allowed.
                 always: nil,
-                # A list of tools that never require approval.
+                # A filter object to specify which tools are allowed.
                 never: nil
               )
               end
@@ -304,24 +819,46 @@ module OpenAI
                     )
                   end
 
-                # List of tools that require approval.
+                # Indicates whether or not a tool modifies data or is read-only. If an MCP server
+                # is
+                # [annotated with `readOnlyHint`](https://modelcontextprotocol.io/specification/2025-06-18/schema#toolannotations-readonlyhint),
+                # it will match this filter.
+                sig { returns(T.nilable(T::Boolean)) }
+                attr_reader :read_only
+
+                sig { params(read_only: T::Boolean).void }
+                attr_writer :read_only
+
+                # List of allowed tool names.
                 sig { returns(T.nilable(T::Array[String])) }
                 attr_reader :tool_names
 
                 sig { params(tool_names: T::Array[String]).void }
                 attr_writer :tool_names
 
-                # A list of tools that always require approval.
+                # A filter object to specify which tools are allowed.
                 sig do
-                  params(tool_names: T::Array[String]).returns(T.attached_class)
+                  params(
+                    read_only: T::Boolean,
+                    tool_names: T::Array[String]
+                  ).returns(T.attached_class)
                 end
                 def self.new(
-                  # List of tools that require approval.
+                  # Indicates whether or not a tool modifies data or is read-only. If an MCP server
+                  # is
+                  # [annotated with `readOnlyHint`](https://modelcontextprotocol.io/specification/2025-06-18/schema#toolannotations-readonlyhint),
+                  # it will match this filter.
+                  read_only: nil,
+                  # List of allowed tool names.
                   tool_names: nil
                 )
                 end
 
-                sig { override.returns({ tool_names: T::Array[String] }) }
+                sig do
+                  override.returns(
+                    { read_only: T::Boolean, tool_names: T::Array[String] }
+                  )
+                end
                 def to_hash
                 end
               end
@@ -335,24 +872,46 @@ module OpenAI
                     )
                   end
 
-                # List of tools that do not require approval.
+                # Indicates whether or not a tool modifies data or is read-only. If an MCP server
+                # is
+                # [annotated with `readOnlyHint`](https://modelcontextprotocol.io/specification/2025-06-18/schema#toolannotations-readonlyhint),
+                # it will match this filter.
+                sig { returns(T.nilable(T::Boolean)) }
+                attr_reader :read_only
+
+                sig { params(read_only: T::Boolean).void }
+                attr_writer :read_only
+
+                # List of allowed tool names.
                 sig { returns(T.nilable(T::Array[String])) }
                 attr_reader :tool_names
 
                 sig { params(tool_names: T::Array[String]).void }
                 attr_writer :tool_names
 
-                # A list of tools that never require approval.
+                # A filter object to specify which tools are allowed.
                 sig do
-                  params(tool_names: T::Array[String]).returns(T.attached_class)
+                  params(
+                    read_only: T::Boolean,
+                    tool_names: T::Array[String]
+                  ).returns(T.attached_class)
                 end
                 def self.new(
-                  # List of tools that do not require approval.
+                  # Indicates whether or not a tool modifies data or is read-only. If an MCP server
+                  # is
+                  # [annotated with `readOnlyHint`](https://modelcontextprotocol.io/specification/2025-06-18/schema#toolannotations-readonlyhint),
+                  # it will match this filter.
+                  read_only: nil,
+                  # List of allowed tool names.
                   tool_names: nil
                 )
                 end
 
-                sig { override.returns({ tool_names: T::Array[String] }) }
+                sig do
+                  override.returns(
+                    { read_only: T::Boolean, tool_names: T::Array[String] }
+                  )
+                end
                 def to_hash
                 end
               end