Class SourceTool

java.lang.Object

org.tentackle.maven.plugin.mcp.tool.SourceTool

All Implemented Interfaces:

ModelTool

public class SourceTool
extends Object
implements ModelTool

Returns the model definition of an entity as text.

raw is what the file holds, canonical and compact are printed from the resolved model and are therefore the form to imitate when writing a new definition.

Author:

harald

Field Summary

Fields

Modifier and Type	Field	Description
static final String[]	FORMATS	The available formats.
static final String	NAME	The tool name.

Constructor Summary

Constructors

Constructor	Description
SourceTool()	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.

Methods inherited from class Object

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

Methods inherited from interface ModelTool

isReadOnly

Field Details

NAME

public static final String NAME

The tool name.

See Also:

• Constant Field Values

FORMATS

public static final String[] FORMATS

The available formats.

Constructor Details

SourceTool

public SourceTool()

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