|
| 1 | +/* |
| 2 | + * Copyright 2024-2026 the original author or authors. |
| 3 | + * |
| 4 | + * Licensed under the Apache License, Version 2.0 (the "License"); |
| 5 | + * you may not use this file except in compliance with the License. |
| 6 | + * You may obtain a copy of the License at |
| 7 | + * |
| 8 | + * http://www.apache.org/licenses/LICENSE-2.0 |
| 9 | + * |
| 10 | + * Unless required by applicable law or agreed to in writing, software |
| 11 | + * distributed under the License is distributed on an "AS IS" BASIS, |
| 12 | + * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. |
| 13 | + * See the License for the specific language governing permissions and |
| 14 | + * limitations under the License. |
| 15 | + */ |
| 16 | +package io.agentscope.core.tool; |
| 17 | + |
| 18 | +import com.github.victools.jsonschema.generator.FieldScope; |
| 19 | +import com.github.victools.jsonschema.generator.MemberScope; |
| 20 | +import com.github.victools.jsonschema.generator.Module; |
| 21 | +import com.github.victools.jsonschema.generator.SchemaGeneratorConfigBuilder; |
| 22 | +import com.github.victools.jsonschema.generator.SchemaGeneratorConfigPart; |
| 23 | +import java.util.stream.Stream; |
| 24 | + |
| 25 | +/** |
| 26 | + * A victools JSON Schema {@link Module} that reads {@link ToolParam} annotations |
| 27 | + * to populate {@code "description"} and {@code "required"} in the generated schema. |
| 28 | + * |
| 29 | + * <p>By default, un-annotated fields are treated as required. Pass |
| 30 | + * {@link Option#PROPERTY_REQUIRED_FALSE_BY_DEFAULT} to invert this. |
| 31 | + * |
| 32 | + * @see ToolParam |
| 33 | + */ |
| 34 | +public class ToolSchemaModule implements Module { |
| 35 | + |
| 36 | + private final boolean requiredByDefault; |
| 37 | + |
| 38 | + /** |
| 39 | + * Creates a module with the given options. |
| 40 | + * |
| 41 | + * @param options pass {@link Option#PROPERTY_REQUIRED_FALSE_BY_DEFAULT} |
| 42 | + * to treat un-annotated fields as optional |
| 43 | + */ |
| 44 | + public ToolSchemaModule(Option... options) { |
| 45 | + this.requiredByDefault = |
| 46 | + Stream.of(options) |
| 47 | + .noneMatch(option -> option == Option.PROPERTY_REQUIRED_FALSE_BY_DEFAULT); |
| 48 | + } |
| 49 | + |
| 50 | + @Override |
| 51 | + public void applyToConfigBuilder(SchemaGeneratorConfigBuilder builder) { |
| 52 | + this.applyToConfigBuilder(builder.forFields()); |
| 53 | + } |
| 54 | + |
| 55 | + /** |
| 56 | + * Registers description resolver and required check. |
| 57 | + */ |
| 58 | + private void applyToConfigBuilder(SchemaGeneratorConfigPart<FieldScope> configPart) { |
| 59 | + configPart.withPropertyNameOverrideResolver(this::resolvePropertyName); |
| 60 | + configPart.withDescriptionResolver(this::resolveDescription); |
| 61 | + configPart.withRequiredCheck(this::checkRequired); |
| 62 | + } |
| 63 | + |
| 64 | + /** |
| 65 | + * Returns the {@code @ToolParam} name, or {@code null} if absent. |
| 66 | + * |
| 67 | + * @param member the field or getter being processed |
| 68 | + * @return the property name, or {@code null} |
| 69 | + */ |
| 70 | + private String resolvePropertyName(FieldScope member) { |
| 71 | + ToolParam toolParam = member.getAnnotationConsideringFieldAndGetter(ToolParam.class); |
| 72 | + if (toolParam != null && hasText(toolParam.name())) { |
| 73 | + return toolParam.name(); |
| 74 | + } |
| 75 | + return null; |
| 76 | + } |
| 77 | + |
| 78 | + /** |
| 79 | + * Returns the {@code @ToolParam} description, or {@code null} if absent. |
| 80 | + * |
| 81 | + * @param member the field or getter being processed |
| 82 | + * @return the description text, or {@code null} |
| 83 | + */ |
| 84 | + private String resolveDescription(MemberScope<?, ?> member) { |
| 85 | + ToolParam toolParam = member.getAnnotationConsideringFieldAndGetter(ToolParam.class); |
| 86 | + if (toolParam != null && hasText(toolParam.description())) { |
| 87 | + return toolParam.description(); |
| 88 | + } |
| 89 | + return null; |
| 90 | + } |
| 91 | + |
| 92 | + /** |
| 93 | + * Returns {@code @ToolParam.required()}, falling back to {@link #requiredByDefault}. |
| 94 | + * |
| 95 | + * @param member the field or getter being processed |
| 96 | + * @return {@code true} if the field should be required |
| 97 | + */ |
| 98 | + private boolean checkRequired(MemberScope<?, ?> member) { |
| 99 | + ToolParam toolParam = member.getAnnotationConsideringFieldAndGetter(ToolParam.class); |
| 100 | + if (toolParam != null) { |
| 101 | + return toolParam.required(); |
| 102 | + } |
| 103 | + return this.requiredByDefault; |
| 104 | + } |
| 105 | + |
| 106 | + /** |
| 107 | + * Returns {@code true} if the string is non-null and non-blank. |
| 108 | + */ |
| 109 | + private static boolean hasText(String str) { |
| 110 | + return str != null && !str.isBlank(); |
| 111 | + } |
| 112 | + |
| 113 | + /** |
| 114 | + * Options for customizing module behavior. |
| 115 | + */ |
| 116 | + public enum Option { |
| 117 | + |
| 118 | + /** |
| 119 | + * Treat un-annotated fields as optional instead of required. |
| 120 | + */ |
| 121 | + PROPERTY_REQUIRED_FALSE_BY_DEFAULT |
| 122 | + } |
| 123 | +} |
0 commit comments