Struct DescribeTableTool 

pub struct DescribeTableTool;

Describe the columns of a table. Returns each column’s name, type, whether it is NOT NULL, its default value, and whether it is part of the primary key. Useful for inspecting a table’s schema before writing queries.

Trait Implementations

impl Clone for DescribeTableTool

fn clone(&self) -> DescribeTableTool

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Debug for DescribeTableTool

fn fmt(&self, f: &mut Formatter<'_>) -> Result

Formats the value using the given formatter.

impl Default for DescribeTableTool

fn default() -> DescribeTableTool

Returns the “default value” for a type.

impl<'de> Deserialize<'de> for DescribeTableTool

fn deserialize<__D>(__deserializer: __D) -> Result<Self, __D::Error>

where __D: Deserializer<'de>,

Deserialize this value from the given Serde deserializer.

impl Hash for DescribeTableTool

fn hash<__H: Hasher>(&self, state: &mut __H)

Feeds this value into the given Hasher.

fn hash_slice<H>(data: &[Self], state: &mut H)

where H: Hasher, Self: Sized,

Feeds a slice of this type into the given Hasher.

impl JsonSchema for DescribeTableTool

fn schema_name() -> Cow<'static, str>

The name of the generated JSON Schema.

fn schema_id() -> Cow<'static, str>

Returns a string that uniquely identifies the schema produced by this type.

fn json_schema(generator: &mut SchemaGenerator) -> Schema

Generates a JSON Schema for this type.

fn inline_schema() -> bool

Whether JSON Schemas generated for this type should be included directly in parent schemas, rather than being re-used where possible using the $ref keyword.

impl Ord for DescribeTableTool

fn cmp(&self, other: &DescribeTableTool) -> Ordering

This method returns an Ordering between self and other.

fn max(self, other: Self) -> Self

where Self: Sized,

Compares and returns the maximum of two values.

fn min(self, other: Self) -> Self

where Self: Sized,

Compares and returns the minimum of two values.

fn clamp(self, min: Self, max: Self) -> Self

where Self: Sized,

Restrict a value to a certain interval.

impl PartialEq for DescribeTableTool

fn eq(&self, other: &DescribeTableTool) -> bool

Tests for self and other values to be equal, and is used by ==.

fn ne(&self, other: &Rhs) -> bool

Tests for !=. The default implementation is almost always sufficient, and should not be overridden without very good reason.

impl PartialOrd for DescribeTableTool

fn partial_cmp(&self, other: &DescribeTableTool) -> Option<Ordering>

This method returns an ordering between self and other values if one exists.

fn lt(&self, other: &Rhs) -> bool

Tests less than (for self and other) and is used by the < operator.

fn le(&self, other: &Rhs) -> bool

Tests less than or equal to (for self and other) and is used by the <= operator.

fn gt(&self, other: &Rhs) -> bool

Tests greater than (for self and other) and is used by the > operator.

fn ge(&self, other: &Rhs) -> bool

Tests greater than or equal to (for self and other) and is used by the >= operator.

impl Serialize for DescribeTableTool

fn serialize<__S>(&self, __serializer: __S) -> Result<__S::Ok, __S::Error>

where __S: Serializer,

Serialize this value into the given Serde serializer.

impl SqliteServerTool for DescribeTableTool

const NAME: &str = "describe_table"

The tool name advertised to MCP clients (e.g. "execute").

type Context = McpServerSqlite

The server type passed to the handler on each invocation, typically McpServerSqlite.

type Error = ToolError<DescribeTableError>

The error type returned by the handler. Must implement IntoContents so rmcp can render it as error content.

type Input = DescribeTableInput

The deserialized input parameters received from the MCP client.

type Output = DescribeTableOutput

The structured output returned to the MCP client on success.

fn handle( ctx: &Self::Context, input: Self::Input, ) -> Result<Self::Output, Self::Error>

Executes the tool’s logic against the given context and input. Called synchronously on the tokio blocking thread pool.

fn tool() -> Tool

Builds the rmcp Tool definition for this tool, including its name, description (extracted from the JsonSchema derive), input schema, and output schema.

fn handler_func() -> fn(&<Self as SqliteServerTool>::Context, Parameters<<Self as SqliteServerTool>::Input>) -> Result<Json<<Self as SqliteServerTool>::Output>, <Self as SqliteServerTool>::Error>

Returns a closure that deserializes the input parameters, calls handle, and wraps the output in Json for structured MCP responses. Every invocation is automatically traced with the tool name, duration, and outcome. The closure is compatible with ToolRouter::with_route.

impl Copy for DescribeTableTool

impl Eq for DescribeTableTool

impl StructuralPartialEq for DescribeTableTool