component-shape-mcp-macros 0.3.4

Proc macros for component-shape-mcp schema helpers.
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
use super::*;

pub(crate) fn expand_mcp_json_schema(input: DeriveInput) -> syn::Result<proc_macro2::TokenStream> {
    let schema_options = SchemaOptions::parse(&input)?;
    let ident = input.ident;
    let mut generics = input.generics;
    let mcp_crate = schema_options
        .crate_path
        .clone()
        .map(Ok)
        .unwrap_or_else(resolve_default_mcp_crate_path)?;
    let data = match input.data {
        Data::Struct(data) => data,
        Data::Enum(data) => {
            return expand_enum_mcp_json_schema(ident, generics, data, schema_options, mcp_crate);
        },
        _ => {
            return Err(syn::Error::new(
                ident.span(),
                "McpJsonSchema can only be derived for structs or fieldless enums",
            ));
        },
    };
    if schema_options.transparent {
        let ty = transparent_field_type(&data.fields)?;
        let schema_tokens = described_schema_tokens(
            quote! { <#ty as #mcp_crate::McpJsonSchema>::json_schema() },
            schema_options.description.as_deref(),
            ident.span(),
        );
        generics
            .make_where_clause()
            .predicates
            .push(parse_quote!(#ty: #mcp_crate::McpJsonSchema));
        let (impl_generics, ty_generics, where_clause) = generics.split_for_impl();
        return Ok(quote! {
            impl #impl_generics #mcp_crate::McpJsonSchema for #ident #ty_generics
                #where_clause
            {
                fn json_schema() -> #mcp_crate::McpSchema {
                    #schema_tokens
                }
            }
        });
    }

    let fields = match data.fields {
        Fields::Named(fields) => fields,
        Fields::Unnamed(fields) if fields.unnamed.len() == 1 => {
            let ty = &fields
                .unnamed
                .first()
                .expect("newtype field should exist")
                .ty;
            let schema_tokens = described_schema_tokens(
                quote! { <#ty as #mcp_crate::McpJsonSchema>::json_schema() },
                schema_options.description.as_deref(),
                ident.span(),
            );
            generics
                .make_where_clause()
                .predicates
                .push(parse_quote!(#ty: #mcp_crate::McpJsonSchema));
            let (impl_generics, ty_generics, where_clause) = generics.split_for_impl();
            return Ok(quote! {
                impl #impl_generics #mcp_crate::McpJsonSchema for #ident #ty_generics
                    #where_clause
                {
                    fn json_schema() -> #mcp_crate::McpSchema {
                        #schema_tokens
                    }
                }
            });
        },
        _ => {
            return Err(syn::Error::new(
                ident.span(),
                "McpJsonSchema requires a struct with named fields or a single-field tuple newtype",
            ));
        },
    };

    let mut field_tokens = Vec::new();
    let mut field_names = BTreeMap::new();

    for field in fields.named {
        let Some(field_ident) = field.ident.clone() else {
            continue;
        };
        let options = FieldOptions::parse(&field)?;
        if options.skip {
            continue;
        }

        let defaulted = options.defaulted();
        let rust_field_name = field_ident.unraw().to_string();
        let serde_field_name = options
            .serde_rename
            .clone()
            .or_else(|| {
                schema_options
                    .serde_rename_all
                    .map(|rule| rule.apply_serde_field(&rust_field_name))
            })
            .unwrap_or_else(|| rust_field_name.clone());
        let field_name = options
            .mcp_rename
            .clone()
            .or_else(|| {
                schema_options
                    .mcp_rename_all
                    .map(|rule| rule.apply_mcp(&rust_field_name))
            })
            .unwrap_or_else(|| serde_field_name.clone());
        claim_wire_name(
            &mut field_names,
            &field_name,
            field_ident.span(),
            "MCP schema field or alias",
        )?;
        for alias in &options.aliases {
            claim_wire_name(
                &mut field_names,
                alias,
                field_ident.span(),
                "MCP schema field or alias",
            )?;
        }
        let field_name = LitStr::new(&field_name, field_ident.span());
        let alias_lits = options
            .aliases
            .iter()
            .map(|alias| LitStr::new(alias, field_ident.span()))
            .collect::<Vec<_>>();
        let decode_name = (field_name.value() != serde_field_name)
            .then(|| LitStr::new(&serde_field_name, field_ident.span()));
        let description = options
            .description
            .or_else(|| doc_description(&field.attrs))
            .map(|description| LitStr::new(&description, field_ident.span()));
        let required = options.required.unwrap_or_else(|| {
            !is_option_type(&field.ty) && !defaulted && !schema_options.defaulted
        });
        let ty = field.ty;
        generics
            .make_where_clause()
            .predicates
            .push(parse_quote!(#ty: #mcp_crate::McpJsonSchema));
        let description_tokens = description
            .map(|description| {
                quote! {
                    __component_shape_mcp_field_schema.set_description(#description);
                }
            })
            .unwrap_or_default();
        let alias_extension_tokens = alias_extension_tokens(&mcp_crate, &alias_lits);
        let decode_name_extension_tokens =
            decode_name_extension_tokens(&mcp_crate, decode_name.as_ref());

        field_tokens.push(quote! {
            {
                let mut __component_shape_mcp_field_schema =
                    <#ty as #mcp_crate::McpJsonSchema>::json_schema();
                #description_tokens
                #alias_extension_tokens
                #decode_name_extension_tokens
                __component_shape_mcp_properties.insert(
                    #field_name.to_string(),
                    __component_shape_mcp_field_schema,
                );
                if #required {
                    __component_shape_mcp_required.push(
                        #field_name.to_string(),
                    );
                }
            }
        });
    }

    let (impl_generics, ty_generics, where_clause) = generics.split_for_impl();
    let schema_tokens = described_schema_tokens(
        quote! {
            #mcp_crate::object_schema(
                __component_shape_mcp_properties,
                __component_shape_mcp_required,
            )
        },
        schema_options.description.as_deref(),
        ident.span(),
    );

    Ok(quote! {
        impl #impl_generics #mcp_crate::McpJsonSchema for #ident #ty_generics
            #where_clause
        {
            fn json_schema() -> #mcp_crate::McpSchema {
                let mut __component_shape_mcp_properties =
                    #mcp_crate::McpSchemaProperties::new();
                let mut __component_shape_mcp_required = Vec::new();

                #(#field_tokens)*

                #schema_tokens
            }
        }
    })
}

pub(crate) fn described_schema_tokens(
    schema_tokens: proc_macro2::TokenStream,
    description: Option<&str>,
    span: proc_macro2::Span,
) -> proc_macro2::TokenStream {
    let Some(description) = description else {
        return schema_tokens;
    };
    let description = LitStr::new(description, span);
    quote! {
        #schema_tokens.with_description(#description)
    }
}

pub(crate) fn alias_extension_tokens(
    mcp_crate: &Path,
    aliases: &[LitStr],
) -> proc_macro2::TokenStream {
    if aliases.is_empty() {
        return proc_macro2::TokenStream::new();
    }

    quote! {
        __component_shape_mcp_field_schema.set_extension(
            "x-mcpAliases",
            #mcp_crate::serde_json::json!([#(#aliases),*]),
        );
    }
}

pub(crate) fn decode_name_extension_tokens(
    mcp_crate: &Path,
    decode_name: Option<&LitStr>,
) -> proc_macro2::TokenStream {
    let Some(decode_name) = decode_name else {
        return proc_macro2::TokenStream::new();
    };

    quote! {
        __component_shape_mcp_field_schema.set_extension(
            "x-mcpDecodeName",
            #mcp_crate::serde_json::Value::String(#decode_name.to_string()),
        );
    }
}

fn transparent_field_type(fields: &Fields) -> syn::Result<Type> {
    match fields {
        Fields::Named(fields) if fields.named.len() == 1 => Ok(fields
            .named
            .first()
            .expect("transparent named field should exist")
            .ty
            .clone()),
        Fields::Unnamed(fields) if fields.unnamed.len() == 1 => Ok(fields
            .unnamed
            .first()
            .expect("transparent tuple field should exist")
            .ty
            .clone()),
        _ => Err(syn::Error::new_spanned(
            fields,
            "McpJsonSchema transparent structs must have exactly one field",
        )),
    }
}

fn expand_enum_mcp_json_schema(
    ident: Ident,
    generics: syn::Generics,
    data: syn::DataEnum,
    schema_options: SchemaOptions,
    mcp_crate: Path,
) -> syn::Result<proc_macro2::TokenStream> {
    let mut value_tokens = Vec::new();
    let mut decode_aliases = Vec::new();
    let mut enum_values = BTreeMap::new();

    for variant in data.variants {
        let options = VariantOptions::parse(&variant)?;
        if options.skip {
            continue;
        }
        if !matches!(&variant.fields, Fields::Unit) {
            return Err(syn::Error::new_spanned(
                variant.ident,
                "McpJsonSchema can only infer fieldless enum variants; add `#[mcp(skip)]` or implement `McpJsonSchema` manually",
            ));
        }

        let rust_variant_name = variant.ident.unraw().to_string();
        let serde_name = options
            .serde_rename
            .clone()
            .or_else(|| {
                schema_options
                    .serde_rename_all
                    .map(|rule| rule.apply_serde_variant(&rust_variant_name))
            })
            .unwrap_or_else(|| rust_variant_name.clone());
        let primary_name = options
            .mcp_rename
            .clone()
            .or_else(|| {
                schema_options
                    .mcp_rename_all
                    .map(|rule| rule.apply_mcp(&rust_variant_name))
            })
            .unwrap_or_else(|| serde_name.clone());
        claim_wire_name(
            &mut enum_values,
            &primary_name,
            variant.ident.span(),
            "MCP enum value",
        )?;
        if primary_name != serde_name {
            decode_aliases.push((
                LitStr::new(&primary_name, variant.ident.span()),
                LitStr::new(&serde_name, variant.ident.span()),
            ));
        }
        value_tokens.push(enum_value_push_tokens(&primary_name, variant.ident.span()));
        for alias in options.aliases {
            claim_wire_name(
                &mut enum_values,
                &alias,
                variant.ident.span(),
                "MCP enum value",
            )?;
            if alias != serde_name {
                decode_aliases.push((
                    LitStr::new(&alias, variant.ident.span()),
                    LitStr::new(&serde_name, variant.ident.span()),
                ));
            }
            value_tokens.push(enum_value_push_tokens(&alias, variant.ident.span()));
        }
    }

    if value_tokens.is_empty() {
        return Err(syn::Error::new(
            ident.span(),
            "McpJsonSchema enum schemas require at least one visible unit variant",
        ));
    }

    let (impl_generics, ty_generics, where_clause) = generics.split_for_impl();
    let enum_decode_alias_extension_tokens =
        enum_decode_alias_extension_tokens(&mcp_crate, &decode_aliases);
    let schema_tokens = described_schema_tokens(
        quote! {
            {
                let mut __component_shape_mcp_schema =
                    #mcp_crate::McpSchema::string()
                        .with_enum_values(__component_shape_mcp_enum_values);
                #enum_decode_alias_extension_tokens
                __component_shape_mcp_schema
            }
        },
        schema_options.description.as_deref(),
        ident.span(),
    );

    Ok(quote! {
        impl #impl_generics #mcp_crate::McpJsonSchema for #ident #ty_generics
            #where_clause
        {
            fn json_schema() -> #mcp_crate::McpSchema {
                let mut __component_shape_mcp_enum_values = Vec::new();
                #(#value_tokens)*
                #schema_tokens
            }
        }
    })
}

fn enum_value_push_tokens(value: &str, span: proc_macro2::Span) -> proc_macro2::TokenStream {
    let value = LitStr::new(value, span);
    quote! {
        __component_shape_mcp_enum_values.push(#value.to_string());
    }
}

fn enum_decode_alias_extension_tokens(
    mcp_crate: &Path,
    aliases: &[(LitStr, LitStr)],
) -> proc_macro2::TokenStream {
    if aliases.is_empty() {
        return proc_macro2::TokenStream::new();
    }

    let wire_values = aliases.iter().map(|(wire, _)| wire);
    let decode_values = aliases.iter().map(|(_, decode)| decode);

    quote! {
        __component_shape_mcp_schema.set_extension(
            "x-mcpEnumDecodeAliases",
            #mcp_crate::serde_json::json!({
                #(#wire_values: #decode_values),*
            }),
        );
    }
}