reckfellENGINE

EditorMcpService

Editor-owned native MCP dispatcher for Reckfell tools.

On this page
class EditorMcpServiceReckfellSharpEditorInherits Entity

Editor-owned native MCP dispatcher for Reckfell tools.

Obtain this service through EditorInterface.GetMcpService. It shares the same commands between external MCP clients and the built-in AI panel. All object operations execute on the editor thread. Runtime and managed requests return job identifiers; observe EditorMcpService.GetJob before treating a submission as complete. The service is available only in editor builds and must not be instantiated by projects.

Declarations checked against C# SDK 1.0.0. Expand a name to see declarations and documentation.

Methods13

CheckedPathstring
# CheckedPath
C#
public string CheckedPath(string path, bool write = false);

Resolves a permitted project path, or returns an empty string for an out-of-scope path. Used by the shipped managed service.

Parameters
NameTypeDefault
pathstring—
writeboolfalse
Returns string
CompleteJobvoid
# CompleteJob
C#
public void CompleteJob(string id, Reckfell.Collections.Dictionary result);

Completes an engine integration job on the editor thread. Late results after cancellation are ignored.

Parameters
NameTypeDefault
idstring—
resultReckfell.Collections.Dictionary—
ExecuteReckfell.Collections.Dictionary
# Execute
C#
public Reckfell.Collections.Dictionary Execute(string tool, Reckfell.Collections.Dictionary arguments);

Executes a registered tool action. Returns an explicit success/error dictionary or a tracked job identifier. Must run on the main thread.

Parameters
NameTypeDefault
toolstring—
argumentsReckfell.Collections.Dictionary—
Returns Reckfell.Collections.Dictionary
GetJobReckfell.Collections.Dictionary
# GetJob
C#
public Reckfell.Collections.Dictionary GetJob(string id);

Returns a job state and its completed result.

Parameters
NameTypeDefault
idstring—
Returns Reckfell.Collections.Dictionary
GetStatusReckfell.Collections.Dictionary
# GetStatus
C#
public Reckfell.Collections.Dictionary GetStatus();

Returns URL, process and project identities, trust and managed-service status. Does not return credentials.

Returns Reckfell.Collections.Dictionary
GetToolsReckfell.Collections.Array
# GetTools
C#
public Reckfell.Collections.Array GetTools(string query = "");

Finds tool groups by name, description and action.

Parameters
NameTypeDefault
querystring""
Returns Reckfell.Collections.Array
IsTrustedbool
# IsTrusted
C#
public bool IsTrusted();

Reports the current editor-session trust decision.

Returns bool
NewJobstring
# NewJob
C#
public string NewJob(string kind);

Allocates an engine integration job.

Parameters
NameTypeDefault
kindstring—
Returns string
RestoreFileCheckpointReckfell.Collections.Dictionary
# RestoreFileCheckpoint
C#
public Reckfell.Collections.Dictionary RestoreFileCheckpoint(string id);

Engine integration rollback for a persisted checkpoint in this project. Checks hashes and unsaved editor state. Remains available to the shipped managed host after editing permission is revoked so cancellation can finish restoring its files. This method is not an external MCP tool.

Parameters
NameTypeDefault
idstring—
Returns Reckfell.Collections.Dictionary
SetManagedHandlervoid
# SetManagedHandler
C#
public void SetManagedHandler(Callable handler);

Registers the shipped managed editor service. Intended for engine integration.

Parameters
NameTypeDefault
handlerCallable—
SetTrustedvoid
# SetTrusted
C#
public void SetTrusted(bool trusted);

Controls autonomous project edits. External MCP clients cannot change this through the tool catalog.

Parameters
NameTypeDefault
trustedbool—
StartServerError
# StartServer
C#
public Error StartServer(int port = 0);

Starts a bearer-authenticated loopback HTTP server. Zero chooses an unused port. Connection metadata is written to the project editor data directory with a Windows owner-only ACL.

Parameters
NameTypeDefault
portint0
Returns Error
StopServervoid
# StopServer
C#
public void StopServer();

Stops the HTTP worker and removes this editor's connection file.

Signals and events2

ActivityEvent
# Activity
C#
public event EditorMcpService.ActivityEventHandler Activity;

Emitted after a dispatched command with action, status and sequence. Credentials and arguments are excluded.

Handler parameters
NameTypeDefault
entryReckfell.Collections.Dictionary—
JobCompletedEvent
# JobCompleted
C#
public event EditorMcpService.JobCompletedEventHandler JobCompleted;

Emitted when a tracked operation completes or fails.

Handler parameters
NameTypeDefault
idstring—
resultReckfell.Collections.Dictionary—
Reckfell Engine documentationBack to top ↑
QUICK LINKSGetting startedEntity hierarchyC# & .NET 10Scenes and prefabs
Reckfell guides and full API K
reckfellENGINE
RECKFELL ACCOUNT

Sign in

Sign in to your Reckfell account.

One account for the entire Reckfell platform.