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

Annotation Interface Tool.Annotations

Enclosing class:

Tool

@Retention(RUNTIME)
@Target(ANNOTATION_TYPE)
public static @interface Tool.Annotations

specifications available

Optional Element Summary

Optional Elements

Modifier and Type	Optional Element	Description
boolean	destructiveHint	If true, the tool may perform destructive updates to its environment.
boolean	idempotentHint	If true, calling the tool repeatedly with the same arguments will have no additional effect on the its environment.
boolean	openWorldHint	If true, this tool may interact with an "open world" of external entities.
boolean	readOnlyHint	If true, the tool does not modify its environment.
boolean	returnDirect	hint indicating that the tool's result should be returned directly to the client, rather than being processed or modified by the server
String	title	A human-readable title for the tool.

Element Details

title

String title

A human-readable title for the tool.

Default:

""

readOnlyHint

boolean readOnlyHint

If true, the tool does not modify its environment.

Default:

false

destructiveHint

boolean destructiveHint

If true, the tool may perform destructive updates to its environment. If false, the tool performs only additive updates.

Default:

true

idempotentHint

boolean idempotentHint

If true, calling the tool repeatedly with the same arguments will have no additional effect on the its environment.

Default:

false

openWorldHint

boolean openWorldHint

If true, this tool may interact with an "open world" of external entities. If false, the tool's domain of interaction is closed.

Default:

true

returnDirect

boolean returnDirect

hint indicating that the tool's result should be returned directly to the client, rather than being processed or modified by the server

Default:

true