universal-tool-macros 0.1.11

DEPRECATED: Use agentic-tools-* crates and agentic-mcp instead. Procedural macros for Universal Tool Framework.
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
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
299
300
301
302
303
304
305
306
307
308
309
310
311
312
313
314
315
316
317
318
319
320
321
322
323
324
325
326
327
328
329
330
331
332
333
334
335
336
337
338
339
340
341
342
343
344
345
346
347
348
349
350
351
352
353
354
355
356
357
358
359
360
361
362
363
364
365
366
367
368
369
370
371
372
373
374
375
376
377
378
379
380
381
382
383
384
385
386
387
388
389
390
391
392
393
394
395
396
397
398
399
400
401
402
403
404
405
406
407
408
409
410
411
412
413
414
415
416
417
418
419
420
421
422
423
424
425
426
427
428
429
430
431
432
433
434
435
436
437
438
439
440
441
442
443
444
445
446
447
448
449
450
451
452
453
454
455
456
457
458
459
460
461
462
463
464
465
466
467
//! MCP (Model Context Protocol) code generation for Universal Tool Framework
//!
//! This module generates `handle_mcp_call()` and `get_mcp_tools()` methods
//! that enable tools to integrate with MCP servers.

use crate::codegen::shared::is_optional_type;
use crate::codegen::validation;
use crate::model::ParamDef;
use crate::model::RouterDef;
use crate::model::ToolDef;
use proc_macro2::TokenStream;
use quote::quote;

/// Generates all MCP-related methods for a router
pub fn generate_mcp_methods(router: &RouterDef) -> TokenStream {
    let struct_type = &router.struct_type;
    let dispatch_method = generate_mcp_dispatch_method(router);
    let dispatch_method_mcp = generate_mcp_dispatch_method_mcp(router);
    let tools_method = generate_mcp_tools_method(router);
    let server_info_method = generate_mcp_server_info_method(router);

    quote! {
        impl #struct_type {
            #dispatch_method

            #dispatch_method_mcp

            #tools_method

            #server_info_method
        }
    }
}

/// Generates the handle_mcp_call() method for dispatching MCP tool calls
fn generate_mcp_dispatch_method(router: &RouterDef) -> TokenStream {
    let match_arms: Vec<_> = router.tools.iter().map(generate_tool_match_arm).collect();

    quote! {
        /// Handles MCP tool calls by dispatching to the appropriate tool method
        /// Users integrate this into their MCP server implementation
        pub async fn handle_mcp_call(
            &self,
            method: &str,
            params: ::serde_json::Value
        ) -> ::std::result::Result<::serde_json::Value, ::universal_tool_core::error::ToolError> {
            match method {
                #(#match_arms)*
                _ => {
                    ::std::result::Result::Err(
                        ::universal_tool_core::error::ToolError::new(
                            ::universal_tool_core::error::ErrorCode::NotFound,
                            ::std::format!("Unknown method: {}", method)
                        )
                    )
                }
            }
        }
    }
}

/// Generates the handle_mcp_call_mcp() method that returns McpOutput (Text or Json)
fn generate_mcp_dispatch_method_mcp(router: &RouterDef) -> TokenStream {
    let match_arms: Vec<_> = router
        .tools
        .iter()
        .map(generate_tool_match_arm_mcp)
        .collect();

    quote! {
        /// Handles MCP tool calls and returns McpOutput (Text or Json), honoring per-tool output mode.
        pub async fn handle_mcp_call_mcp(
            &self,
            method: &str,
            params: ::serde_json::Value
        ) -> ::std::result::Result<::universal_tool_core::mcp::McpOutput, ::universal_tool_core::error::ToolError> {
            match method {
                #(#match_arms)*
                _ => {
                    ::std::result::Result::Err(
                        ::universal_tool_core::error::ToolError::new(
                            ::universal_tool_core::error::ErrorCode::NotFound,
                            ::std::format!("Unknown method: {}", method)
                        )
                    )
                }
            }
        }
    }
}

/// Generates a match arm for a single tool
fn generate_tool_match_arm(tool: &ToolDef) -> TokenStream {
    let tool_name = &tool.tool_name;

    // Generate per-field extraction bindings for MCP
    let param_extractions = crate::codegen::validation::generate_params_extraction(tool, "mcp");

    // Determine if we have any includable params (excluding ProgressReporter/CancellationToken)
    let has_includable_params = tool
        .params
        .iter()
        .any(|p| crate::codegen::validation::should_include_param(p, "mcp"));

    // If there are includable params, assert params is a JSON object and bind it
    let object_assertion = if has_includable_params {
        quote! {
            let params = match params {
                ::serde_json::Value::Object(map) => map,
                _ => {
                    return ::std::result::Result::Err(
                        ::universal_tool_core::error::ToolError::new(
                            ::universal_tool_core::error::ErrorCode::InvalidArgument,
                            "Parameters must be a JSON object"
                        )
                    );
                }
            };
        }
    } else {
        quote! {}
    };

    // Generate method call (now uses local variables instead of params.#field)
    let method_call = generate_method_call(tool);

    quote! {
        #tool_name => {
            #object_assertion
            #( #param_extractions )*

            #method_call
        }
    }
}

/// Generates the method call with proper parameter passing and result serialization
fn generate_method_call(tool: &ToolDef) -> TokenStream {
    // Build parameter list, handling special MCP parameters
    // For normal params, use the local variable bound by per-field extraction
    let param_args: Vec<_> = tool
        .params
        .iter()
        .map(|param| {
            let name = &param.name;
            let ty = &param.ty;
            let ty_str = quote!(#ty).to_string();

            if ty_str.contains("ProgressReporter") {
                // For now, pass None for progress reporter
                // TODO(3): In the future, could accept progress_token in params and create reporter
                quote! { None }
            } else if ty_str.contains("CancellationToken") {
                // Create a new cancellation token
                // TODO(3): In the future, could get from MCP request context
                quote! { ::universal_tool_core::mcp::CancellationToken::new() }
            } else {
                // Regular parameter - use local variable binding
                quote! { #name }
            }
        })
        .collect();

    // Use the shared function to generate the method call with proper async/sync handling
    let method_call =
        crate::codegen::shared::generate_normalized_method_call(tool, quote! { self }, param_args);

    quote! {
        let result = #method_call?;
        ::std::result::Result::Ok(::serde_json::to_value(&result)?)
    }
}

/// Generates a match arm for the new MCP dispatch method with output mode support
fn generate_tool_match_arm_mcp(tool: &ToolDef) -> TokenStream {
    let tool_name = &tool.tool_name;

    // Generate per-field extraction bindings for MCP
    let param_extractions = crate::codegen::validation::generate_params_extraction(tool, "mcp");

    // Determine if we have any includable params (excluding ProgressReporter/CancellationToken)
    let has_includable_params = tool
        .params
        .iter()
        .any(|p| crate::codegen::validation::should_include_param(p, "mcp"));

    // If there are includable params, assert params is a JSON object and bind it
    let object_assertion = if has_includable_params {
        quote! {
            let params = match params {
                ::serde_json::Value::Object(map) => map,
                _ => {
                    return ::std::result::Result::Err(
                        ::universal_tool_core::error::ToolError::new(
                            ::universal_tool_core::error::ErrorCode::InvalidArgument,
                            "Parameters must be a JSON object"
                        )
                    );
                }
            };
        }
    } else {
        quote! {}
    };

    // Build parameter args list using local bindings
    let param_args: Vec<_> = tool
        .params
        .iter()
        .map(|param| {
            let name = &param.name;
            let ty = &param.ty;
            let ty_str = quote!(#ty).to_string();

            if ty_str.contains("ProgressReporter") {
                quote! { None }
            } else if ty_str.contains("CancellationToken") {
                quote! { ::universal_tool_core::mcp::CancellationToken::new() }
            } else {
                quote! { #name }
            }
        })
        .collect();

    let method_call =
        crate::codegen::shared::generate_normalized_method_call(tool, quote! { self }, param_args);

    // Determine output mode at codegen time
    let output_mode_tokens = if let Some(mcp_config) = &tool.metadata.mcp_config {
        if matches!(
            mcp_config.output_mode,
            Some(crate::model::McpOutputMode::Text)
        ) {
            // TEXT mode: require McpFormatter at compile time
            quote! {
                let result = #method_call?;
                let text = ::universal_tool_core::mcp::McpFormatter::mcp_format_text(&result);
                ::std::result::Result::Ok(::universal_tool_core::mcp::McpOutput::Text(text))
            }
        } else {
            // JSON mode
            quote! {
                let result = #method_call?;
                let val = ::serde_json::to_value(&result)?;
                ::std::result::Result::Ok(::universal_tool_core::mcp::McpOutput::Json(val))
            }
        }
    } else {
        // Default to JSON
        quote! {
            let result = #method_call?;
            let val = ::serde_json::to_value(&result)?;
            ::std::result::Result::Ok(::universal_tool_core::mcp::McpOutput::Json(val))
        }
    };

    quote! {
        #tool_name => {
            #object_assertion
            #( #param_extractions )*
            #output_mode_tokens
        }
    }
}

/// Generates the get_mcp_tools() method for tool discovery
fn generate_mcp_tools_method(router: &RouterDef) -> TokenStream {
    let tool_definitions = router.tools.iter().map(generate_tool_definition);

    quote! {
        /// Returns tool definitions for MCP discovery
        /// Users can use this to implement list_tools in their ServerHandler
        pub fn get_mcp_tools(&self) -> ::std::vec::Vec<::serde_json::Value> {
            ::std::vec![
                #(#tool_definitions),*
            ]
        }
    }
}

/// Generates a tool definition JSON for MCP discovery
fn generate_tool_definition(tool: &ToolDef) -> TokenStream {
    let name = &tool.tool_name;
    let description = &tool.metadata.description;

    // Generate input schema
    let schema = generate_tool_schema(tool);

    // Build the tool definition based on whether we have annotations
    if let Some(mcp_config) = &tool.metadata.mcp_config {
        let mut has_annotations = false;
        let mut annotation_fields = vec![];

        if let Some(v) = mcp_config.annotations.read_only_hint {
            has_annotations = true;
            annotation_fields.push(quote! { "readOnlyHint": #v });
        }
        if let Some(v) = mcp_config.annotations.destructive_hint {
            has_annotations = true;
            annotation_fields.push(quote! { "destructiveHint": #v });
        }
        if let Some(v) = mcp_config.annotations.idempotent_hint {
            has_annotations = true;
            annotation_fields.push(quote! { "idempotentHint": #v });
        }
        if let Some(v) = mcp_config.annotations.open_world_hint {
            has_annotations = true;
            annotation_fields.push(quote! { "openWorldHint": #v });
        }

        if has_annotations {
            quote! {
                {
                    let schema = #schema;
                    let mut tool_def = ::serde_json::json!({
                        "name": #name,
                        "description": #description,
                        "inputSchema": schema
                    });
                    tool_def["annotations"] = ::serde_json::json!({
                        #(#annotation_fields),*
                    });
                    tool_def
                }
            }
        } else {
            quote! {
                {
                    let schema = #schema;
                    ::serde_json::json!({
                        "name": #name,
                        "description": #description,
                        "inputSchema": schema
                    })
                }
            }
        }
    } else {
        quote! {
            {
                let schema = #schema;
                ::serde_json::json!({
                    "name": #name,
                    "description": #description,
                    "inputSchema": schema
                })
            }
        }
    }
}

/// Generates JSON schema for a single parameter using schemars
fn generate_param_schema(param: &ParamDef) -> TokenStream {
    let param_type = &param.ty;
    let description = &param.metadata.description.as_deref().unwrap_or("");

    quote! {
        {
            let mut settings = ::universal_tool_core::schemars::r#gen::SchemaSettings::draft07();
            settings.inline_subschemas = true;
            let mut schema_gen = settings.into_generator();
            let schema = <#param_type as ::universal_tool_core::JsonSchema>::json_schema(&mut schema_gen);
            let mut json_schema = ::serde_json::to_value(&schema).unwrap_or_else(|_| ::serde_json::json!({"type": "string"}));
            if let ::serde_json::Value::Object(ref mut map) = json_schema {
                if !#description.is_empty() {
                    map.insert("description".to_string(), ::serde_json::Value::String(#description.to_string()));
                }
            }
            json_schema
        }
    }
}

/// Generates JSON schema for tool parameters
fn generate_tool_schema(tool: &ToolDef) -> TokenStream {
    // Filter out special MCP parameters from schema
    let schema_params: Vec<_> = tool
        .params
        .iter()
        .filter(|param| validation::should_include_param(param, "mcp"))
        .collect();

    if schema_params.is_empty() {
        // No parameters - empty object schema
        quote! {
            ::serde_json::json!({
                "type": "object",
                "properties": {},
                "required": []
            })
        }
    } else {
        // Generate properties using schemars
        let param_schemas: Vec<_> = schema_params
            .iter()
            .map(|param| {
                let name = &param.name.to_string();
                let schema = generate_param_schema(param);
                let required = !is_optional_type(&param.ty);
                quote! {
                    properties.insert(#name.to_string(), #schema);
                    if #required {
                        required.push(#name.to_string());
                    }
                }
            })
            .collect();

        quote! {
            {
                let mut properties = ::serde_json::Map::new();
                let mut required = Vec::new();

                #(#param_schemas)*

                ::serde_json::json!({
                    "type": "object",
                    "properties": properties,
                    "required": required
                })
            }
        }
    }
}

/// Generates get_mcp_server_info() returning (name, version) with router-level precedence
fn generate_mcp_server_info_method(router: &RouterDef) -> TokenStream {
    // Determine default name from struct type last segment
    let default_name = router
        .struct_type
        .segments
        .last()
        .map(|s| s.ident.to_string())
        .unwrap_or_else(|| "tools".to_string());

    // Compute name: RouterMcpConfig.name or default struct name
    let name_val: String = router
        .metadata
        .mcp_config
        .as_ref()
        .and_then(|c| c.name.as_ref())
        .cloned()
        .unwrap_or(default_name);

    // Compute version tokens:
    // - If RouterMcpConfig.version set, embed that literal.
    // - Otherwise, embed env!("CARGO_PKG_VERSION") at use-site crate.
    let version_tokens: TokenStream = if let Some(cfg) = &router.metadata.mcp_config {
        if let Some(ver) = &cfg.version {
            let ver_lit = ver.clone();
            quote! { #ver_lit.to_string() }
        } else {
            quote! { env!("CARGO_PKG_VERSION").to_string() }
        }
    } else {
        quote! { env!("CARGO_PKG_VERSION").to_string() }
    };

    quote! {
        /// Returns (server name, server version) for MCP initialize response serverInfo
        pub fn get_mcp_server_info(&self) -> (String, String) {
            let name = #name_val.to_string();
            let version = #version_tokens;
            (name, version)
        }
    }
}