Class ReloadTool

java.lang.Object

org.tentackle.maven.plugin.mcp.tool.ReloadTool

All Implemented Interfaces:

ModelTool

public class ReloadTool
extends Object
implements ModelTool

Reloads the model.

Changed files are picked up automatically before every call, so this is only needed when that is not enough: after a rebuild that removed or renamed an entity, or to force a clean reload.

Author:

harald

Field Summary

Fields

Modifier and Type	Field	Description
static final String	NAME	The tool name.

Constructor Summary

Constructors

Constructor	Description
ReloadTool()	Creates the tool.

Method Summary

Modifier and Type	Method	Description
String	execute(ModelSession session, ToolArguments args)	Executes the tool.
String	getDescription()	Gets the description telling an agent when to use this tool.
String	getInputSchema()	Gets the JSON schema of the arguments.
String	getName()	Gets the tool name as seen by the client.
String	getTitle()	Gets the human-readable title.
boolean	isReadOnly()	Returns whether this tool only reads the model.

Methods inherited from class Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Field Details

NAME

public static final String NAME

The tool name.

See Also:

• Constant Field Values

Constructor Details

ReloadTool

public ReloadTool()

Creates the tool.

Method Details

getName

public String getName()

Description copied from interface: ModelTool

Gets the tool name as seen by the client.

Specified by:

getName in interface ModelTool

Returns:

the name

getTitle

public String getTitle()

Description copied from interface: ModelTool

Gets the human-readable title.

Specified by:

getTitle in interface ModelTool

Returns:

the title

getDescription

public String getDescription()

Description copied from interface: ModelTool

Gets the description telling an agent when to use this tool.

Specified by:

getDescription in interface ModelTool

Returns:

the description

getInputSchema

public String getInputSchema()

Description copied from interface: ModelTool

Gets the JSON schema of the arguments.

Specified by:

getInputSchema in interface ModelTool

Returns:

the schema

execute

public String execute(ModelSession session,
 ToolArguments args)
               throws ModelException

Description copied from interface: ModelTool

Executes the tool.

Invoked with the model lock held, see ModelSession.call(ModelSession.ModelOperation).

Specified by:

execute in interface ModelTool

Parameters:

session - the model session

args - the arguments, never null

Returns:

the text handed to the model

Throws:

ModelException - if the model is inconsistent

isReadOnly

public boolean isReadOnly()

Description copied from interface: ModelTool

Returns whether this tool only reads the model.

Specified by:

isReadOnly in interface ModelTool

Returns:

true if read-only