Skip to main content

EnhancedPromptBuilder

Struct EnhancedPromptBuilder 

Source
pub struct EnhancedPromptBuilder;
Expand description

Builds enhanced prompt sections with tool usage guidelines

This builder constructs formatted markdown sections containing:

  • Categorized tool guides with examples
  • Best practices for tool usage
  • Schema-only fallback for tools without guides

§Output Format

The generated prompts follow this structure:

## Tool Usage Guidelines

### File Reading Tools
Use these to inspect existing files and structure.

**read_file**
- When to use: Read file contents when you need to understand code
- When NOT to use: When you only need to check if a file exists
- Example: {"path": "/src/main.rs"} -> Reads the main source file
- Related tools: list_directory, search_files

### Best Practices
1. Always verify file paths before reading
2. Use appropriate tools for the task

Implementations§

Source§

impl EnhancedPromptBuilder

Source

pub fn build( registry: Option<&ToolRegistry>, available_schemas: &[ToolSchema], context: &GuideBuildContext, ) -> String

Builds an enhanced prompt section for available tools

This method looks up guides for all provided schemas and generates a formatted markdown section with usage guidelines.

§Arguments
  • registry - Optional tool registry with registered guides
  • available_schemas - List of tool schemas to document
  • context - Build context (language, max examples, etc.)
§Returns

Formatted markdown string with tool usage guidelines

Source

pub fn build_for_tools( registry: Option<&ToolRegistry>, tool_names: &[String], fallback_schemas: &[ToolSchema], context: &GuideBuildContext, ) -> String

Builds an enhanced prompt for a specific set of tools

This method allows specifying exactly which tools to include, even if they’re not in the available schemas.

§Arguments
  • registry - Optional tool registry with registered guides
  • tool_names - Specific tools to document
  • fallback_schemas - Schemas for tools without guides
  • context - Build context (language, max examples, etc.)
§Returns

Formatted markdown string with tool usage guidelines

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> PolicyExt for T
where T: ?Sized,

Source§

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

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