Package io.jenkins.plugins.mcp.server.annotation

Annotation Interface ToolParam

@Target({PARAMETER,FIELD,ANNOTATION_TYPE})
@Retention(RUNTIME)
@Documented
public @interface ToolParam

Optional Element Summary

Optional Elements

Modifier and Type	Optional Element	Description
String	additionalProperties	Extra JSON Schema to use as this parameter's additionalProperties.
String	description	The description of the tool argument.
boolean	required	Whether the tool argument is required.

Element Details

required

boolean required

Whether the tool argument is required.

Default:

true

description

String description

The description of the tool argument.

Default:

""

additionalProperties

String additionalProperties

Extra JSON Schema to use as this parameter's additionalProperties. Handy for a Map parameter: it limits the values while still allowing any key. Must be a JSON object or a boolean. Leave it empty (the default) to keep the generated schema as-is; bad JSON fails when the tool is registered.

Default:

""