Navigation
API > API/Plugins > API/Plugins/ModelContextProtocol
Abstract interface for a describable MCP (Anthropic's Model Context Protocol) tool.
Tools can be registered for use via IModelContextProtocolModule::GetChecked().AddTool and must implement either Run or RunAsync for execution.
| Name | IModelContextProtocolTool |
| Type | struct |
| Header File | /Engine/Plugins/Experimental/ModelContextProtocol/Source/ModelContextProtocol/Public/IModelContextProtocolTool.h |
| Include Path | #include "IModelContextProtocolTool.h" |
Syntax
struct IModelContextProtocolTool : public TSharedFromThis< IModelContextProtocolTool >
Inheritance Hierarchy
- FSharedFromThisBase → TSharedFromThis → IModelContextProtocolTool
Derived Classes
Destructors
| Name | Remarks | Include Path | Unreal Specifiers |
|---|---|---|---|
virtual ~IModelContextProtocolTool() |
IModelContextProtocolTool.h |
Typedefs
| Name | Type | Remarks | Include Path |
|---|---|---|---|
| FResultCallback | TFunction< void(const FModelContextProtocolToolResult &Result)> | Tool result object or error. | IModelContextProtocolTool.h |
Functions
Public
| Name | Remarks | Include Path | Unreal Specifiers |
|---|---|---|---|
FString GetDescription() |
Returns a description of what this tool does when executed, and when it should be used | IModelContextProtocolTool.h | |
FString GetName() |
Returns the identifier name for this tool e.g: select_object | IModelContextProtocolTool.h |
Public Virtual
| Name | Remarks | Include Path | Unreal Specifiers |
|---|---|---|---|
virtual void AddReferencedObjects
(
FReferenceCollector& Collector |
Called by FModelContextProtocolToolCollection to allow tools to report UObject dependencies for reference tracking | IModelContextProtocolTool.h | |
virtual void CancelAsync
(
const FModelContextProtocolToolRequestId& RequestId |
IModelContextProtocolTool.h | ||
virtual TSharedPtr< FJsonObject > GetInputJsonSchema () |
Returns the JSON Schema definition which the input parameters to this tool must adhere to. | IModelContextProtocolTool.h | |
virtual TSharedPtr< FJsonObject > GetOutputJsonSchema () |
Returns an optional JSON Schema definition which the results of this tool must adhere to. | IModelContextProtocolTool.h | |
virtual FModelContextProtocolToolResult Run
(
const TSharedPtr< FJsonObject >& Params |
Executes this tool, performing the described operations, using Params as input, immediately returning a result. | IModelContextProtocolTool.h | |
virtual void RunAsync
(
const FModelContextProtocolToolRequestId& RequestId, |
Executes this tool asynchronously, performing the described operations over time, using Params as input. | IModelContextProtocolTool.h |