Package org.eclipse.mcp.experimental.annotated

Class MCPAnnotatedToolFactory

java.lang.Object

org.eclipse.mcp.factory.ToolFactory

org.eclipse.mcp.experimental.annotated.MCPAnnotatedToolFactory

All Implemented Interfaces:

IFactory

Direct Known Subclasses:

AnnotatedToolFactory, BuiltinAnnotatedToolsFactory

public class MCPAnnotatedToolFactory
extends ToolFactory

Conveniences for creating one or more ToolFactories from annotated Java methods. A JSON Input schema for your method's arguments will be constructed and basic mappings to/from JSON will be handled. Arguments may be of types Boolean,Character, Double, Float, Integer, Long, Short, String[] Integer[] No JSON Output Schema is generated at this time

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
static @interface	MCPAnnotatedToolFactory.Tool	Tool Schema Reference
static @interface	MCPAnnotatedToolFactory.ToolArg

Nested classes/interfaces inherited from class org.eclipse.mcp.factory.ToolFactory

ToolFactory.ToolVisibilityListener

Constructor Summary

Constructors

Constructor	Description
MCPAnnotatedToolFactory(Method method, MCPAnnotatedToolFactory.Tool toolAnnotation)

Method Summary

Modifier and Type	Method	Description
McpSchema.CallToolResult	apply(McpSyncServerExchange exchange, McpSchema.CallToolRequest req)
Object	apply(Map<String,Object> args)	Simplistic method to transform a map of input arguments to a String[] response
String	createInputSchema()
String	createOutputSchema()
McpSchema.Tool	createTool()	Create the definition for your tool.
static ToolFactory[]	createToolFactories(Class<?> c)
static ToolFactory[]	createToolFactories(Class<?>[] classes)
String	getDescription()
String	getName()
boolean	isValid()

Methods inherited from class org.eclipse.mcp.factory.ToolFactory

addVisibilityListener, createSpec, isVisible, removeVisibilityListener, setVisibility

Methods inherited from class java.lang.Object

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

Methods inherited from interface org.eclipse.mcp.factory.IFactory

getId, getJsonSchemaJacksonOptions

Constructor Details

MCPAnnotatedToolFactory

public MCPAnnotatedToolFactory(Method method,
 MCPAnnotatedToolFactory.Tool toolAnnotation)

Method Details

createToolFactories

public static ToolFactory[] createToolFactories(Class<?>[] classes)
                                         throws MCPException

Throws:

MCPException

createToolFactories

public static ToolFactory[] createToolFactories(Class<?> c)
                                         throws MCPException

Throws:

MCPException

createInputSchema

public String createInputSchema()

createOutputSchema

public String createOutputSchema()

getName

public String getName()

getDescription

public String getDescription()

isValid

public boolean isValid()

createTool

public McpSchema.Tool createTool()

Description copied from class: ToolFactory

Create the definition for your tool. see MCPAnnotatedToolFactory to automatically create tools from annotated Java methods

Specified by:

createTool in class ToolFactory

Returns:

apply

public McpSchema.CallToolResult apply(McpSyncServerExchange exchange,
 McpSchema.CallToolRequest req)

Overrides:

apply in class ToolFactory

apply

public Object apply(Map<String,Object> args)
             throws MCPException

Description copied from class: ToolFactory

Simplistic method to transform a map of input arguments to a String[] response

Specified by:

apply in class ToolFactory

Parameters:

args -

Returns:

For simplistic responses return String or String[]

Throws:

MCPException