Struct ListToolsResult 

#[non_exhaustive]
pub struct ListToolsResult {
    pub tools: Vec<ToolInfo>,
    pub next_cursor: Cursor,
    pub ttl_ms: Option<u64>,
    pub cache_scope: Option<CacheScope>,
}

List tools response.

Backward Compatibility

This struct is #[non_exhaustive]. Use the constructor to remain forward-compatible:

use pmcp::types::ListToolsResult;

let result = ListToolsResult::new(vec![]);

Within the same crate, struct literal syntax with ..Default::default() also works.

Fields (Non-exhaustive)

Non-exhaustive structs could have additional fields added in future. Therefore, non-exhaustive structs cannot be constructed in external crates using the traditional Struct { .. } syntax; cannot be matched against without a wildcard ..; and struct update syntax will not work.

tools: Vec<ToolInfo>

Available tools

next_cursor: Cursor

Pagination cursor for next page

ttl_ms: Option<u64>

How long (in milliseconds) a client MAY cache this response — the 2026-07-28 CacheableResult.ttlMs hint.

u64 is the MEASURED mapping: the vendored artifact declares $defs.CacheableResult.properties.ttlMs as {"type": "integer", "minimum": 0} (asserted by tests/v2_core_schema_facts.rs), so integrality and non-negativity are contract. The one residual is the absent upper bound — JSON Schema integer is unbounded while u64 is not — which at millisecond resolution is roughly 584 million years and is an ACCEPTED risk.

None means the handler expressed no preference; the v2 projection then emits the safe default DEFAULT_TTL_MS (0, “immediately stale”) — D-08.

v2 only. On a 2025-11-25 wire the key is never emitted, and a value set here is actively STRIPPED (D-11).

Why Option when the wire says REQUIRED (D-07). The field is required on the 2026-07-28 projection, but modelling it as Option plus inject-on-v2 fails CLOSED (a missed path merely omits a hint), whereas a non-Option field plus strip-on-v1 fails OPEN (a missed path leaks a v2 key onto the v1 wire).

Not to be confused with TaskV2::ttl_ms, which is a task LIFETIME rather than a cache-freshness hint (D-10).

No builder by design. ListToolsResult is built by the dispatcher from the registered tool set, with no handler seam, so a builder method here would be public API no server author can reach through normal configuration — unlike ListResourcesResult and ReadResourceResult, which a ResourceHandler returns from list and read and which therefore do carry builders. The field stays pub, so a caller constructing the struct directly can still set it.

(ListResourceTemplatesResult carries builders too, but is NOT handler-reachable — see its own note. Two of the six cacheable results are settable through a handler, not three; 115-10 corrected an earlier version of this paragraph that said three.)

Adding this field is additive rather than a major bump because this struct is #[non_exhaustive], so cargo semver-checks’ constructible_struct_adds_field does not fire.

cache_scope: Option<CacheScope>

The intended sharing scope of the cached response — the 2026-07-28 CacheableResult.cacheScope hint.

None means the handler expressed no preference; the v2 projection then emits the safe default CacheScope::Private (D-08). Read CacheScope’s # Security section before setting Public: it authorizes a shared gateway to serve this body across authorization contexts.

v2 only. On a 2025-11-25 wire the key is never emitted, and a value set here is actively STRIPPED (D-11).

Why Option when the wire says REQUIRED (D-07): see ttl_ms.

No builder by design — see ttl_ms. Additive under semver for the same #[non_exhaustive] reason.

Implementations

impl ListToolsResult

pub fn new(tools: Vec<ToolInfo>) -> Self

Create a new list tools result.

pub fn with_next_cursor(self, cursor: impl Into<String>) -> Self

Set the pagination cursor for the next page.

Trait Implementations

impl Clone for ListToolsResult

fn clone(&self) -> ListToolsResult

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Debug for ListToolsResult

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

Formats the value using the given formatter.

impl Default for ListToolsResult

fn default() -> ListToolsResult

Returns the “default value” for a type.

impl<'de> Deserialize<'de> for ListToolsResult

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

where __D: Deserializer<'de>,

Deserialize this value from the given Serde deserializer.

impl Serialize for ListToolsResult

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

where __S: Serializer,

Serialize this value into the given Serde serializer.