Constructor Detail

Method Detail

• serverLabel

   final BetaTool.Mcp.Builder serverLabel(String serverLabel)

  A label for this MCP server, used to identify it in tool calls.

• serverLabel

   final BetaTool.Mcp.Builder serverLabel(JsonField<String> serverLabel)

  Sets Builder.serverLabel to an arbitrary JSON value.

  You should usually call Builder.serverLabel with a well-typed String value instead. This method is primarily for setting the field to an undocumented or not yet supported value.

• type

   final BetaTool.Mcp.Builder type(JsonValue type)

  Sets the field to an arbitrary JSON value.

  It is usually unnecessary to call this method because the field defaults to the following:

  JsonValue.from("mcp")

  This method is primarily for setting the field to an undocumented or not yet supported value.

• allowedCallers

   final BetaTool.Mcp.Builder allowedCallers(List<BetaTool.Mcp.AllowedCaller> allowedCallers)

  The tool invocation context(s).

• allowedCallers

   final BetaTool.Mcp.Builder allowedCallers(Optional<List<BetaTool.Mcp.AllowedCaller>> allowedCallers)

  Alias for calling Builder.allowedCallers with allowedCallers.orElse(null).

• allowedCallers

   final BetaTool.Mcp.Builder allowedCallers(JsonField<List<BetaTool.Mcp.AllowedCaller>> allowedCallers)

  Sets Builder.allowedCallers to an arbitrary JSON value.

  You should usually call Builder.allowedCallers with a well-typed List<AllowedCaller> value instead. This method is primarily for setting the field to an undocumented or not yet supported value.

• addAllowedCaller

   final BetaTool.Mcp.Builder addAllowedCaller(BetaTool.Mcp.AllowedCaller allowedCaller)

  Adds a single AllowedCaller to allowedCallers.

• allowedTools

   final BetaTool.Mcp.Builder allowedTools(BetaTool.Mcp.AllowedTools allowedTools)

  List of allowed tool names or a filter object.

• allowedTools

   final BetaTool.Mcp.Builder allowedTools(Optional<BetaTool.Mcp.AllowedTools> allowedTools)

  Alias for calling Builder.allowedTools with allowedTools.orElse(null).

• allowedTools

   final BetaTool.Mcp.Builder allowedTools(JsonField<BetaTool.Mcp.AllowedTools> allowedTools)

  Sets Builder.allowedTools to an arbitrary JSON value.

  You should usually call Builder.allowedTools with a well-typed AllowedTools value instead. This method is primarily for setting the field to an undocumented or not yet supported value.

• allowedTools

   final BetaTool.Mcp.Builder allowedTools(BetaTool.Mcp.AllowedTools.McpToolFilter mcpToolFilter)

  Alias for calling allowedTools with AllowedTools.ofMcpToolFilter(mcpToolFilter).

• allowedToolsOfMcp

   final BetaTool.Mcp.Builder allowedToolsOfMcp(List<String> mcp)

  Alias for calling allowedTools with AllowedTools.ofMcp(mcp).

• authorization

   final BetaTool.Mcp.Builder authorization(String authorization)

  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

   final BetaTool.Mcp.Builder authorization(JsonField<String> authorization)

  Sets Builder.authorization to an arbitrary JSON value.

  You should usually call Builder.authorization with a well-typed String value instead. This method is primarily for setting the field to an undocumented or not yet supported value.

• connectorId

   final BetaTool.Mcp.Builder connectorId(BetaTool.Mcp.ConnectorId connectorId)

  Identifier for service connectors, like those available in ChatGPT. One of server_url, connector_id, or tunnel_id must be provided. Learn more about service connectors here.

  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

• connectorId

   final BetaTool.Mcp.Builder connectorId(JsonField<BetaTool.Mcp.ConnectorId> connectorId)

  Sets Builder.connectorId to an arbitrary JSON value.

  You should usually call Builder.connectorId with a well-typed ConnectorId value instead. This method is primarily for setting the field to an undocumented or not yet supported value.

• deferLoading

   final BetaTool.Mcp.Builder deferLoading(Boolean deferLoading)

  Whether this MCP tool is deferred and discovered via tool search.

• deferLoading

   final BetaTool.Mcp.Builder deferLoading(JsonField<Boolean> deferLoading)

  Sets Builder.deferLoading to an arbitrary JSON value.

  You should usually call Builder.deferLoading with a well-typed Boolean value instead. This method is primarily for setting the field to an undocumented or not yet supported value.

• headers

   final BetaTool.Mcp.Builder headers(BetaTool.Mcp.Headers headers)

  Optional HTTP headers to send to the MCP server. Use for authentication or other purposes.

• headers

   final BetaTool.Mcp.Builder headers(Optional<BetaTool.Mcp.Headers> headers)

  Alias for calling Builder.headers with headers.orElse(null).

• headers

   final BetaTool.Mcp.Builder headers(JsonField<BetaTool.Mcp.Headers> headers)

  Sets Builder.headers to an arbitrary JSON value.

  You should usually call Builder.headers with a well-typed Headers value instead. This method is primarily for setting the field to an undocumented or not yet supported value.

• requireApproval

   final BetaTool.Mcp.Builder requireApproval(BetaTool.Mcp.RequireApproval requireApproval)

  Specify which of the MCP server's tools require approval.

• requireApproval

   final BetaTool.Mcp.Builder requireApproval(Optional<BetaTool.Mcp.RequireApproval> requireApproval)

  Alias for calling Builder.requireApproval with requireApproval.orElse(null).

• requireApproval

   final BetaTool.Mcp.Builder requireApproval(JsonField<BetaTool.Mcp.RequireApproval> requireApproval)

  Sets Builder.requireApproval to an arbitrary JSON value.

  You should usually call Builder.requireApproval with a well-typed RequireApproval value instead. This method is primarily for setting the field to an undocumented or not yet supported value.

• requireApproval

   final BetaTool.Mcp.Builder requireApproval(BetaTool.Mcp.RequireApproval.McpToolApprovalFilter mcpToolApprovalFilter)

  Alias for calling requireApproval with RequireApproval.ofMcpToolApprovalFilter(mcpToolApprovalFilter).

• requireApproval

   final BetaTool.Mcp.Builder requireApproval(BetaTool.Mcp.RequireApproval.McpToolApprovalSetting mcpToolApprovalSetting)

  Alias for calling requireApproval with RequireApproval.ofMcpToolApprovalSetting(mcpToolApprovalSetting).

• serverDescription

   final BetaTool.Mcp.Builder serverDescription(String serverDescription)

  Optional description of the MCP server, used to provide more context.

• serverDescription

   final BetaTool.Mcp.Builder serverDescription(JsonField<String> serverDescription)

  Sets Builder.serverDescription to an arbitrary JSON value.

  You should usually call Builder.serverDescription with a well-typed String value instead. This method is primarily for setting the field to an undocumented or not yet supported value.

• serverUrl

   final BetaTool.Mcp.Builder serverUrl(String serverUrl)

  The URL for the MCP server. One of server_url, connector_id, or tunnel_id must be provided.

• serverUrl

   final BetaTool.Mcp.Builder serverUrl(JsonField<String> serverUrl)

  Sets Builder.serverUrl to an arbitrary JSON value.

  You should usually call Builder.serverUrl with a well-typed String value instead. This method is primarily for setting the field to an undocumented or not yet supported value.

• tunnelId

   final BetaTool.Mcp.Builder tunnelId(String tunnelId)

  The Secure MCP Tunnel ID to use instead of a direct server URL. One of server_url, connector_id, or tunnel_id must be provided.

• tunnelId

   final BetaTool.Mcp.Builder tunnelId(JsonField<String> tunnelId)

  Sets Builder.tunnelId to an arbitrary JSON value.

  You should usually call Builder.tunnelId with a well-typed String value instead. This method is primarily for setting the field to an undocumented or not yet supported value.

• additionalProperties

   final BetaTool.Mcp.Builder additionalProperties(Map<String, JsonValue> additionalProperties)

• putAdditionalProperty

   final BetaTool.Mcp.Builder putAdditionalProperty(String key, JsonValue value)

• putAllAdditionalProperties

   final BetaTool.Mcp.Builder putAllAdditionalProperties(Map<String, JsonValue> additionalProperties)

• removeAdditionalProperty

   final BetaTool.Mcp.Builder removeAdditionalProperty(String key)

• removeAllAdditionalProperties

   final BetaTool.Mcp.Builder removeAllAdditionalProperties(Set<String> keys)

• build

   final BetaTool.Mcp build()

  Returns an immutable instance of Mcp.

  Further updates to this Builder will not mutate the returned instance.

  The following fields are required:

  .serverLabel()