Struct ToolDecl 

pub struct ToolDecl {
    pub name: String,
    pub description: Option<String>,
    pub sql: Option<String>,
    pub path: Option<String>,
    pub method: Option<String>,
    pub base_url: Option<String>,
    pub script: Option<String>,
    pub ui_resource_uri: Option<String>,
    pub parameters: Vec<ParamDecl>,
    pub annotations: Option<AnnotationsDecl>,
}

Single [[tools]] entry — a declaratively-defined tool surface.

Fields

name: String

Tool name (required for production via ServerConfig::validate).

description: Option<String>

Human-readable tool description.

sql: Option<String>

SQL template (uses :param placeholders bound by ParamDecl).

path: Option<String>

HTTP request path for a single-call OpenAPI/REST tool (D-01), e.g. "/Line/Mode/tube/Status". Concatenated onto the backend base_url (or this tool’s Self::base_url override). Additive per REF-01 — None for SQL / script tools.

method: Option<String>

HTTP method for a single-call tool ("GET", "POST", …). Pairs with Self::path (D-01). Additive; None for SQL / script tools.

base_url: Option<String>

Per-tool backend base-URL override. When absent a single-call tool inherits [backend].base_url. Additive; None for SQL / script tools.

script: Option<String>

JavaScript body for a script tool (D-01) — a code-mode snippet that orchestrates multiple backend calls and binds [[tools.parameters]] to args. When set, this entry is a script tool (Self::is_script_tool). Additive; None for SQL / single-call tools.

ui_resource_uri: Option<String>

Optional UI-resource URI for structuredContent widgets.

parameters: Vec<ParamDecl>

[[tools.parameters]] — declared input parameters.

annotations: Option<AnnotationsDecl>

[tools.annotations] — MCP toolAnnotations.

Implementations

impl ToolDecl

pub fn is_script_tool(&self) -> bool

Whether this [[tools]] entry is a script tool (D-01 detection rule).

The detection rule is: script.is_some() ⇒ script tool; otherwise a path + method pair ⇒ single-call HTTP tool; otherwise (a sql field) ⇒ SQL tool. Plan 03/05 synthesizers branch on this method so the rule lives in exactly one place. Mutual-exclusivity is enforced at ServerConfig::validate (an entry mixing kinds is rejected, not silently resolved by precedence).

Examples

use pmcp_server_toolkit::config::ToolDecl;

let script = ToolDecl { script: Some("await api.get('/x')".into()), ..Default::default() };
assert!(script.is_script_tool());

let single = ToolDecl {
    path: Some("/Line/Mode/tube/Status".into()),
    method: Some("GET".into()),
    ..Default::default()
};
assert!(!single.is_script_tool());

Trait Implementations

impl Clone for ToolDecl

fn clone(&self) -> ToolDecl

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Debug for ToolDecl

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

Formats the value using the given formatter.

impl Default for ToolDecl

fn default() -> ToolDecl

Returns the “default value” for a type.

impl<'de> Deserialize<'de> for ToolDecl

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

where __D: Deserializer<'de>,

Deserialize this value from the given Serde deserializer.

impl PartialEq for ToolDecl

fn eq(&self, other: &ToolDecl) -> 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 Serialize for ToolDecl

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

where __S: Serializer,

Serialize this value into the given Serde serializer.

impl StructuralPartialEq for ToolDecl