Skip to main content

CustomTool

Struct CustomTool 

Source
pub struct CustomTool {
    pub slug: String,
    pub name: String,
    pub description: String,
    pub toolkit: Option<String>,
    pub input_schema: Value,
    pub output_schema: Option<Value>,
    pub requires_auth: bool,
    /* private fields */
}
Expand description

Custom tool definition with execution logic

Fields§

§slug: String

Tool slug (unique identifier, uppercase)

§name: String

Tool name (human-readable)

§description: String

Tool description

§toolkit: Option<String>

Toolkit slug (if toolkit-based)

§input_schema: Value

Input parameters schema (JSON Schema)

§output_schema: Option<Value>

Output schema (optional)

§requires_auth: bool

Whether authentication is required

Implementations§

Source§

impl CustomTool

Source

pub fn new_simple<F>( name: &str, description: &str, input_schema: JsonValue, executor: F, client: Arc<ComposioClient>, ) -> Self
where F: Fn(JsonValue) -> Result<JsonValue, ComposioError> + Send + Sync + 'static,

Create a simple custom tool without authentication

§Arguments
  • name - Tool name (will be converted to uppercase slug)
  • description - Tool description
  • input_schema - JSON Schema for input parameters
  • executor - Function to execute the tool
  • client - Composio client
Source

pub fn new_with_auth<F>( name: &str, description: &str, toolkit: &str, input_schema: JsonValue, executor: F, client: Arc<ComposioClient>, ) -> Self

Create a toolkit-based custom tool with authentication

§Arguments
  • name - Tool name (will be prefixed with toolkit and converted to uppercase)
  • description - Tool description
  • toolkit - Toolkit slug (e.g., “github”)
  • input_schema - JSON Schema for input parameters
  • executor - Function to execute the tool (receives proxy executor and credentials)
  • client - Composio client
Source

pub async fn execute( &self, arguments: HashMap<String, JsonValue>, user_id: Option<&str>, ) -> Result<JsonValue, ComposioError>

Execute the custom tool

§Arguments
  • arguments - Input arguments
  • user_id - User ID (required for authenticated tools)
Source

pub fn to_tool_info(&self) -> ToolInfo

Convert to ToolInfo format (for API compatibility)

Auto Trait Implementations§

Blanket Implementations§

Source§

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

Source§

fn type_id(&self) -> TypeId

Gets the TypeId of self. Read more
Source§

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

Source§

fn borrow(&self) -> &T

Immutably borrows from an owned value. Read more
Source§

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

Source§

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

Mutably borrows from an owned value. Read more
Source§

impl<T> From<T> for T

Source§

fn from(t: T) -> T

Returns the argument unchanged.

Source§

impl<T> Instrument for T

Source§

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

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

fn in_current_span(self) -> Instrumented<Self>

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

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

Source§

fn into(self) -> U

Calls U::from(self).

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

Source§

impl<T> Same for T

Source§

type Output = T

Should always be Self
Source§

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

Source§

type Error = Infallible

The type returned in the event of a conversion error.
Source§

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

Performs the conversion.
Source§

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

Source§

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

The type returned in the event of a conversion error.
Source§

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

Performs the conversion.
Source§

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

Source§

fn vzip(self) -> V

Source§

impl<T> WithSubscriber for T

Source§

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
Source§

fn with_current_subscriber(self) -> WithDispatch<Self>

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