ezMcpDocumentTool Class Reference

Lists, opens, creates, saves, closes and focuses editor documents. More...

#include <DocumentTool.h>

Inheritance diagram for ezMcpDocumentTool:

Public Member Functions
virtual void	GetSupportedTools (ezDynamicArray< ezMcpToolDesc > &out_tools) const override
	Appends the description of every tool that this provider implements.
virtual void	Execute (ezStringView sToolName, const ezVariantDictionary &arguments, ezMcpToolResult &out_result) override
	Executes one of the tools returned by GetSupportedTools().
Public Member Functions inherited from ezMcpToolProvider
virtual void	OnActivate ()
	Called once, right after the provider was instantiated. Use it to hook into the editor.
virtual void	OnDeactivate ()
	Called once, before the provider is destroyed.
Public Member Functions inherited from ezReflectedClass
virtual const ezRTTI *	GetDynamicRTTI () const
bool	IsInstanceOf (const ezRTTI *pType) const
	Returns whether the type of this instance is of the given type or derived from it.
template<typename T >
EZ_ALWAYS_INLINE bool	IsInstanceOf () const
	Returns whether the type of this instance is of the given type or derived from it.

Additional Inherited Members
Static Public Member Functions inherited from ezNoBase
static const ezRTTI *	GetStaticRTTI ()

Detailed Description

Lists, opens, creates, saves, closes and focuses editor documents.

'document_types' is the type-level view - what can be created and with which file extension - and is the call that has to come first, because every other tool here names a document type or a path whose extension decides the type.

The tools that change something are deliberately explicit about it: closing discards unsaved work unless told otherwise, and deleting rewrites other documents. Neither can ask, so both take the decision as an argument (see Status.md, 'A tool must never wait for a human').

Member Function Documentation

Execute()

void ezMcpDocumentTool::Execute ( ezStringView  sToolName, const ezVariantDictionary &  arguments, ezMcpToolResult &  out_result  )

overridevirtual

Executes one of the tools returned by GetSupportedTools().

Parameters

sToolName	The tool to run. A provider with a single tool may ignore this.
arguments	The 'arguments' object of the call. Missing and mistyped values are normal - the client is an AI and will get this wrong. Validate and report through out_result.

Implements ezMcpToolProvider.

GetSupportedTools()

void ezMcpDocumentTool::GetSupportedTools ( ezDynamicArray< ezMcpToolDesc > &  out_tools ) const

overridevirtual

Appends the description of every tool that this provider implements.

Implements ezMcpToolProvider.

---

The documentation for this class was generated from the following files:

• /home/runner/work/ezEngine/ezEngine/Code/EditorPlugins/Mcp/EditorPluginMcp/McpTools/DocumentTool.h
• /home/runner/work/ezEngine/ezEngine/Code/EditorPlugins/Mcp/EditorPluginMcp/McpTools/DocumentTool.cpp