Tools that act on the process itself, rather than on whatever it has loaded. More...

#include <McpAppTool.h>

Inheritance diagram for ezMcpAppTool:

[legend]

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.

Protected Member Functions
virtual ezStringView	GetHostNoun () const =0
	What this process is, e.g. "editor" or "game". Used in the tool descriptions, so that an agent talking to two servers at once can tell which one it is addressing.

virtual ezStringView	GetRelaunchHint () const =0
	How to start another process like this one, appended to app_quit's description.

virtual ezStringView	GetBuildTimestamp () const
	When the binary serving MCP was compiled, reported by app_info as 'buildTimestamp'.

virtual void	AddHostInfo (ezMcpJsonWriter &ref_writer)
	Anything host specific that app_info should report, added to the same object.

virtual ezResult	CanQuit (bool bDiscardChanges)
	Whether quitting is allowed right now. Return EZ_FAILURE to refuse.

virtual void	AddQuitRefusalInfo (ezMcpJsonWriter &ref_writer)
	Explains a refusal from CanQuit(). Writes into the result object, after "quitting": false.

virtual void	AddQuitInfo (ezMcpJsonWriter &ref_writer)
	Anything worth reporting about a quit that is going ahead, e.g. what got discarded.

virtual void	RequestQuit (bool bDiscardChanges)=0
	Actually shuts the process down.

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

Detailed Description

Tools that act on the process itself, rather than on whatever it has loaded.

These exist to close the automation loop: an agent that can launch a process (with '-mcpport' to get its own port), query it and then shut it down again can test a change without a human in between.

Abstract on purpose. Almost all of this is process level rather than editor or game level - the process id, the executable path, the command line, the bound port - so the editor and a running game answer the same four questions and should not make an agent learn two names for each. What differs is host specific and reachable through the virtuals below. ezMcpToolRegistry only instantiates providers whose RTTI can allocate, so declaring this one with ezRTTINoAllocator is what keeps the base from registering its tool names alongside the concrete host's.

Member Function Documentation

◆ AddHostInfo()

virtual void ezMcpAppTool::AddHostInfo ( ezMcpJsonWriter & ref_writer )

inlineprotectedvirtual

Anything host specific that app_info should report, added to the same object.

Reimplemented in ezMcpEditorAppTool, and ezMcpEngineAppTool.

◆ AddQuitInfo()

virtual void ezMcpAppTool::AddQuitInfo ( ezMcpJsonWriter & ref_writer )

inlineprotectedvirtual

Anything worth reporting about a quit that is going ahead, e.g. what got discarded.

Reimplemented in ezMcpEditorAppTool.

◆ AddQuitRefusalInfo()

virtual void ezMcpAppTool::AddQuitRefusalInfo ( ezMcpJsonWriter & ref_writer )

inlineprotectedvirtual

Explains a refusal from CanQuit(). Writes into the result object, after "quitting": false.

Reimplemented in ezMcpEditorAppTool.

◆ CanQuit()

virtual ezResult ezMcpAppTool::CanQuit ( bool bDiscardChanges )

inlineprotectedvirtual

Whether quitting is allowed right now. Return EZ_FAILURE to refuse.

A refusal must never be a question to the user: a modal dialog with nobody at the keyboard never returns, and the process then hangs holding its port. Destructive choices are parameters, which is what bDiscardChanges is.

Reimplemented in ezMcpEditorAppTool.

◆ Execute()

void ezMcpAppTool::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.

Reimplemented in ezMcpEngineAppTool.

◆ GetBuildTimestamp()

ezStringView ezMcpAppTool::GetBuildTimestamp ( ) const

protectedvirtual

When the binary serving MCP was compiled, reported by app_info as 'buildTimestamp'.

Exists because a stale binary is indistinguishable from a missing feature: an agent working from a tools/list produced by a build from a few days ago reports tools as absent, and nothing in the protocol reveals the mismatch. Comparing this against when the source was last changed does.

The default is when the Mcp library itself was built. A host whose own plugin changes more often than the library should override this with its own DATE " " TIME - the tool list comes from the plugin, so that is the binary whose age actually explains a missing tool.

Reimplemented in ezMcpEditorAppTool, and ezMcpEngineAppTool.

◆ GetHostNoun()

virtual ezStringView ezMcpAppTool::GetHostNoun ( ) const

protectedpure virtual

What this process is, e.g. "editor" or "game". Used in the tool descriptions, so that an agent talking to two servers at once can tell which one it is addressing.

Implemented in ezMcpEditorAppTool, and ezMcpEngineAppTool.

◆ GetRelaunchHint()

virtual ezStringView ezMcpAppTool::GetRelaunchHint ( ) const

protectedpure virtual

How to start another process like this one, appended to app_quit's description.

Everything an agent needs has to be in the tool list - it has no repo access and no prior session - so this is where 'which executable, which arguments' gets said.

Implemented in ezMcpEditorAppTool, and ezMcpEngineAppTool.

◆ GetSupportedTools()

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

overridevirtual

Appends the description of every tool that this provider implements.

Implements ezMcpToolProvider.

Reimplemented in ezMcpEngineAppTool.

◆ RequestQuit()

virtual void ezMcpAppTool::RequestQuit ( bool bDiscardChanges )

protectedpure virtual

Actually shuts the process down.

Must defer the shutdown past the end of this call. The response has not reached the socket yet, so quitting synchronously drops it and leaves the caller waiting on a connection that closes with no answer - which is indistinguishable from a crash.

Implemented in ezMcpEditorAppTool, and ezMcpEngineAppTool.

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

/home/runner/work/ezEngine/ezEngine/Code/Engine/Mcp/Tools/McpAppTool.h
/home/runner/work/ezEngine/ezEngine/Code/Engine/Mcp/Tools/McpAppTool.cpp

Public Member Functions

Protected Member Functions

Additional Inherited Members

Detailed Description

Member Function Documentation

◆ AddHostInfo()

◆ AddQuitInfo()

◆ AddQuitRefusalInfo()

◆ CanQuit()

◆ Execute()

◆ GetBuildTimestamp()

◆ GetHostNoun()

◆ GetRelaunchHint()

◆ GetSupportedTools()

◆ RequestQuit()