MCPToolArgs

async_openai_compat::types

Struct MCPToolArgs

pub struct MCPToolArgs { /* private fields */ }

Expand description

Builder for MCPTool.

Implementations§

impl MCPToolArgs

pub fn server_label<VALUE: Into<String>>(&mut self, value: VALUE) -> &mut Self

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

pub fn allowed_tools<VALUE: Into<MCPToolAllowedTools>>( &mut self, value: VALUE, ) -> &mut Self

List of allowed tool names or a filter object.

pub fn authorization<VALUE: Into<String>>(&mut self, value: VALUE) -> &mut Self

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.

pub fn connector_id<VALUE: Into<McpToolConnectorId>>( &mut self, value: VALUE, ) -> &mut Self

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.

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

pub fn headers<VALUE: Into<Value>>(&mut self, value: VALUE) -> &mut Self

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

pub fn require_approval<VALUE: Into<MCPToolRequireApproval>>( &mut self, value: VALUE, ) -> &mut Self

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

pub fn server_description<VALUE: Into<String>>( &mut self, value: VALUE, ) -> &mut Self

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

pub fn server_url<VALUE: Into<String>>(&mut self, value: VALUE) -> &mut Self

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

pub fn build(&self) -> Result<MCPTool, OpenAIError>

Builds a new MCPTool.

§Errors

If a required field has not been initialized.

Trait Implementations§

impl Clone for MCPToolArgs

fn clone(&self) -> MCPToolArgs

Returns a duplicate of the value. Read more

1.0.0§

fn clone_from(&mut self, source: &Self)

Performs copy-assignment from source. Read more

impl Default for MCPToolArgs

fn default() -> Self

Returns the “default value” for a type. Read more

Auto Trait Implementations§

impl Freeze for MCPToolArgs

impl RefUnwindSafe for MCPToolArgs

impl Send for MCPToolArgs

impl Sync for MCPToolArgs

impl Unpin for MCPToolArgs

impl UnwindSafe for MCPToolArgs

Blanket Implementations§

impl<T> Any for T
where T: 'static + ?Sized,

fn type_id(&self) -> TypeId

Gets the TypeId of self. Read more

impl<T> Borrow<T> for T
where T: ?Sized,

fn borrow(&self) -> &T

Immutably borrows from an owned value. Read more

impl<T> BorrowMut<T> for T
where T: ?Sized,

fn borrow_mut(&mut self) -> &mut T

Mutably borrows from an owned value. Read more

impl<T> CloneToUninit for T
where T: Clone,

unsafe fn clone_to_uninit(&self, dest: *mut u8)

🔬This is a nightly-only experimental API. (clone_to_uninit)

Performs copy-assignment from self to dest. Read more

impl<T> From<T> for T

fn from(t: T) -> T

Returns the argument unchanged.

impl<T> Instrument for T

fn instrument(self, span: Span) -> Instrumented<Self>

Instruments this type with the provided Span, returning an Instrumented wrapper. Read more

fn in_current_span(self) -> Instrumented<Self>

Instruments this type with the current Span, returning an Instrumented wrapper. Read more

impl<T, U> Into<U> for T
where U: From<T>,

fn into(self) -> U

Calls U::from(self).

That is, this conversion is whatever the implementation of From<T> for U chooses to do.

impl<T> PolicyExt for T
where T: ?Sized,

fn and<P, B, E>(self, other: P) -> And<T, P>
where T: Policy<B, E>, P: Policy<B, E>,

Create a new Policy that returns Action::Follow only if self and other return Action::Follow. Read more

fn or<P, B, E>(self, other: P) -> Or<T, P>
where T: Policy<B, E>, P: Policy<B, E>,

Create a new Policy that returns Action::Follow if either self or other returns Action::Follow. Read more

impl<T> ToOwned for T
where T: Clone,

type Owned = T

The resulting type after obtaining ownership.

fn to_owned(&self) -> T

Creates owned data from borrowed data, usually by cloning. Read more

fn clone_into(&self, target: &mut T)

Uses borrowed data to replace owned data, usually by cloning. Read more

impl<T, U> TryFrom<U> for T
where U: Into<T>,

type Error = Infallible

The type returned in the event of a conversion error.

fn try_from(value: U) -> Result<T, <T as TryFrom<U>>::Error>

Performs the conversion.

impl<T, U> TryInto<U> for T
where U: TryFrom<T>,

type Error = <U as TryFrom<T>>::Error

The type returned in the event of a conversion error.

fn try_into(self) -> Result<U, <U as TryFrom<T>>::Error>

Performs the conversion.

impl<V, T> VZip<V> for T
where V: MultiLane<T>,

fn vzip(self) -> V

impl<T> WithSubscriber for T

fn with_subscriber<S>(self, subscriber: S) -> WithDispatch<Self>
where S: Into<Dispatch>,

Attaches the provided Subscriber to this type, returning a WithDispatch wrapper. Read more

fn with_current_subscriber(self) -> WithDispatch<Self>

Attaches the current default Subscriber to this type, returning a WithDispatch wrapper. Read more