elicitation 0.8.0

Conversational elicitation of strongly-typed Rust values via MCP
Documentation 
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133

//! MCP tool schemas and parameter builders.

/// MCP tool names used by elicitation.
pub mod tool_names {
    /// Tool for eliciting numeric values with range constraints.
    #[tracing::instrument(level = "trace")]
    pub fn elicit_number() -> String {
        "elicit_number".to_string()
    }

    /// Tool for eliciting boolean values (yes/no).
    #[tracing::instrument(level = "trace")]
    pub fn elicit_bool() -> String {
        "elicit_bool".to_string()
    }

    /// Tool for eliciting free-form text.
    #[tracing::instrument(level = "trace")]
    pub fn elicit_text() -> String {
        "elicit_text".to_string()
    }

    /// Tool for selecting from finite options.
    #[tracing::instrument(level = "trace")]
    pub fn elicit_select() -> String {
        "elicit_select".to_string()
    }

    /// Tool for multi-field surveys.
    #[tracing::instrument(level = "trace")]
    pub fn elicit_survey() -> String {
        "elicit_survey".to_string()
    }
}

/// Build parameters for elicit_number tool.
///
/// # Arguments
///
/// * `prompt` - The prompt to display to the user
/// * `min` - Minimum valid value (inclusive)
/// * `max` - Maximum valid value (inclusive)
///
/// # Returns
///
/// JSON object with prompt, min, and max fields.
#[tracing::instrument(level = "debug")]
pub fn number_params(
    prompt: &str,
    min: i64,
    max: i64,
) -> serde_json::Map<String, serde_json::Value> {
    let mut map = serde_json::Map::new();
    map.insert(
        "prompt".to_string(),
        serde_json::Value::String(prompt.to_string()),
    );
    map.insert("min".to_string(), serde_json::Value::Number(min.into()));
    map.insert("max".to_string(), serde_json::Value::Number(max.into()));
    map
}

/// Build parameters for elicit_bool tool.
///
/// # Arguments
///
/// * `prompt` - The prompt to display to the user
///
/// # Returns
///
/// JSON object with prompt field.
#[tracing::instrument(level = "debug")]
pub fn bool_params(prompt: &str) -> serde_json::Map<String, serde_json::Value> {
    let mut map = serde_json::Map::new();
    map.insert(
        "prompt".to_string(),
        serde_json::Value::String(prompt.to_string()),
    );
    map
}

/// Build parameters for elicit_text tool.
///
/// # Arguments
///
/// * `prompt` - The prompt to display to the user
///
/// # Returns
///
/// JSON object with prompt field.
#[tracing::instrument(level = "debug")]
pub fn text_params(prompt: &str) -> serde_json::Map<String, serde_json::Value> {
    let mut map = serde_json::Map::new();
    map.insert(
        "prompt".to_string(),
        serde_json::Value::String(prompt.to_string()),
    );
    map
}

/// Build parameters for elicit_select tool.
///
/// # Arguments
///
/// * `prompt` - The prompt to display to the user
/// * `options` - Array of valid option labels
///
/// # Returns
///
/// JSON object with prompt and options fields.
///
/// Accepts any collection of string-like items (String, &str, etc.).
#[tracing::instrument(level = "debug", skip(options))]
pub fn select_params<S: AsRef<str>>(
    prompt: &str,
    options: &[S],
) -> serde_json::Map<String, serde_json::Value> {
    let mut map = serde_json::Map::new();
    map.insert(
        "prompt".to_string(),
        serde_json::Value::String(prompt.to_string()),
    );
    map.insert(
        "options".to_string(),
        serde_json::Value::Array(
            options
                .iter()
                .map(|s| serde_json::Value::String(s.as_ref().to_string()))
                .collect(),
        ),
    );
    map
}