Skip to content

Fix local HTTP server lifecycle and TCP connect observation #107

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
dsarno merged 2 commits into from
Dec 31, 2025
Merged

Fix local HTTP server lifecycle and TCP connect observation #107

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
2 commits
Select commit Hold shift + click to select a range
d5eabc6
Fix local server cleanup and connection checks
dsarno Dec 31, 2025
275093a
Fix read_console default limits; cleanup Unity-managed server vestiges
dsarno Dec 31, 2025
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
6 changes: 6 additions & 0 deletions MCPForUnity/Editor/Services/IServerManagementService.cs
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -23,6 +23,12 @@ public interface IServerManagementService
/// </summary>
bool StopLocalHttpServer();

/// <summary>
/// Stop the Unity-managed local HTTP server if a handshake/pidfile exists,
/// even if the current transport selection has changed.
/// </summary>
bool StopManagedLocalHttpServer();

/// <summary>
/// Best-effort detection: returns true if a local MCP HTTP server appears to be running
/// on the configured local URL/port (used to drive UI state even if the session is not active).
Expand Down
30 changes: 16 additions & 14 deletions MCPForUnity/Editor/Services/McpEditorShutdownCleanup.cs
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -40,29 +40,32 @@ private static void OnEditorQuitting()
McpLog.Warn($"Shutdown cleanup: failed to stop transports: {ex.Message}");
}

// 2) Stop local HTTP server if the user selected HTTP Local (best-effort).
// 2) Stop local HTTP server if it was Unity-managed (best-effort).
try
{
bool useHttp = EditorPrefs.GetBool(EditorPrefKeys.UseHttpTransport, true);
if (!useHttp)
{
return;
}

// Prefer explicit scope if present; fall back to URL heuristics for backward compatibility.
string scope = string.Empty;
try { scope = EditorPrefs.GetString(EditorPrefKeys.HttpTransportScope, string.Empty); } catch { }

bool httpLocalSelected = string.Equals(scope, "local", StringComparison.OrdinalIgnoreCase)
|| (string.IsNullOrEmpty(scope) && MCPServiceLocator.Server.IsLocalUrl());
bool stopped = false;
bool httpLocalSelected =
useHttp &&
(string.Equals(scope, "local", StringComparison.OrdinalIgnoreCase)
|| (string.IsNullOrEmpty(scope) && MCPServiceLocator.Server.IsLocalUrl()));

if (!httpLocalSelected)
if (httpLocalSelected)
{
return;
// StopLocalHttpServer is already guarded to only terminate processes that look like mcp-for-unity.
// If it refuses to stop (e.g. URL was edited away from local), fall back to the Unity-managed stop.
stopped = MCPServiceLocator.Server.StopLocalHttpServer();
}

// StopLocalHttpServer is already guarded to only terminate processes that look like mcp-for-unity.
MCPServiceLocator.Server.StopLocalHttpServer();
// Always attempt to stop a Unity-managed server if one exists.
// This covers cases where the user switched transports (e.g. to stdio) or StopLocalHttpServer refused.
if (!stopped)
{
MCPServiceLocator.Server.StopManagedLocalHttpServer();
}
}
catch (Exception ex)
{
Expand All @@ -72,4 +75,3 @@ private static void OnEditorQuitting()
}
}


220 changes: 97 additions & 123 deletions MCPForUnity/Editor/Services/ServerManagementService.cs
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -18,9 +18,6 @@ namespace MCPForUnity.Editor.Services
public class ServerManagementService : IServerManagementService
{
private static readonly HashSet<int> LoggedStopDiagnosticsPids = new HashSet<int>();
private static readonly object LocalHttpServerProcessLock = new object();
private static System.Diagnostics.Process LocalHttpServerProcess;
private static bool OpenedHttpServerLogViewerThisSession;

private static string GetProjectRootPath()
{
Expand All @@ -35,17 +32,6 @@ private static string GetProjectRootPath()
}
}

private static string GetLocalHttpServerLogDirectory()
{
// Prefer Library so it stays project-scoped and out of version control.
return Path.Combine(GetProjectRootPath(), "Library", "MCPForUnity", "Logs");
}

private static string GetLocalHttpServerLogPath()
{
return Path.Combine(GetLocalHttpServerLogDirectory(), "mcp_http_server.log");
}

private static string QuoteIfNeeded(string s)
{
if (string.IsNullOrEmpty(s)) return s;
Expand Down Expand Up @@ -490,14 +476,13 @@ public bool StartLocalHttpServer()
}
catch { }

// Launch the server in a new terminal window (keeps user-visible logs).
var startInfo = CreateTerminalProcessStartInfo(launchCommand);
System.Diagnostics.Process.Start(startInfo);
if (!string.IsNullOrEmpty(pidFilePath))
{
StoreLocalHttpServerHandshake(pidFilePath, instanceToken);
}

// Launch the server in a new terminal window (keeps user-visible logs).
var startInfo = CreateTerminalProcessStartInfo(launchCommand);
System.Diagnostics.Process.Start(startInfo);
McpLog.Info($"Started local HTTP server in terminal: {launchCommand}");
return true;
}
Expand All @@ -515,80 +500,39 @@ public bool StartLocalHttpServer()
return false;
}

private void TryOpenLogInTerminal(string logPath)
/// <summary>
/// Stop the local HTTP server by finding the process listening on the configured port
/// </summary>
public bool StopLocalHttpServer()
{
return StopLocalHttpServerInternal(quiet: false);
}

public bool StopManagedLocalHttpServer()
{
try
if (!TryGetLocalHttpServerHandshake(out var pidFilePath, out _))
{
if (string.IsNullOrEmpty(logPath))
{
return;
}

// Note:
// - The server may log transient HTTP 400 responses on /mcp during startup probing/retries.
// - On shutdown, uvicorn/FastMCP may log CancelledError stack traces when streaming requests are cancelled.
// These are expected and not necessarily indicative of a Unity-side problem.
return false;
}

// Best-effort: don't keep spawning new Terminal windows/tabs for the same log file every time the server is restarted.
// Without AppleScript, we can't reliably detect whether a Terminal window is already tailing this file, so we
// avoid re-opening within the same Unity Editor session.
if (OpenedHttpServerLogViewerThisSession)
int port = 0;
if (!TryGetPortFromPidFilePath(pidFilePath, out port) || port <= 0)
{
string baseUrl = HttpEndpointUtility.GetBaseUrl();
if (IsLocalUrl(baseUrl)
&& Uri.TryCreate(baseUrl, UriKind.Absolute, out var uri)
&& uri.Port > 0)
{
return;
port = uri.Port;
}
}

string tailCommand = $"tail -n 200 -f \"{logPath.Replace("\"", "\\\"")}\"";

#if UNITY_EDITOR_OSX
// Avoid AppleScript (which can trigger automation permission prompts).
// Create a .command script and open it with Terminal.
string scriptsDir = Path.Combine(GetProjectRootPath(), "Library", "MCPForUnity", "TerminalScripts");
Directory.CreateDirectory(scriptsDir);
string scriptPath = Path.Combine(scriptsDir, "tail-mcp-http-server.command");
File.WriteAllText(
scriptPath,
"#!/bin/bash\n" +
"set -e\n" +
"clear\n" +
"echo \"Tailing MCP For Unity server log...\"\n" +
$"{tailCommand}\n");

ExecPath.TryRun("/bin/chmod", $"+x \"{scriptPath}\"", Application.dataPath, out _, out _, 3000);
System.Diagnostics.Process.Start(new System.Diagnostics.ProcessStartInfo
{
FileName = "/usr/bin/open",
Arguments = $"-a Terminal \"{scriptPath}\"",
UseShellExecute = false,
CreateNoWindow = true
});
OpenedHttpServerLogViewerThisSession = true;
#elif UNITY_EDITOR_WIN
// Use PowerShell tail for better behavior.
string ps = $"powershell -NoProfile -Command \"Get-Content -Path '{logPath.Replace("'", "''")}' -Wait -Tail 200\"";
System.Diagnostics.Process.Start(new System.Diagnostics.ProcessStartInfo
{
FileName = "cmd.exe",
Arguments = $"/c start \"MCP Server Logs\" {ps}",
UseShellExecute = false,
CreateNoWindow = true
});
OpenedHttpServerLogViewerThisSession = true;
#else
// Linux: reuse terminal launcher for a simple tail command.
var startInfo = CreateTerminalProcessStartInfo(tailCommand);
System.Diagnostics.Process.Start(startInfo);
OpenedHttpServerLogViewerThisSession = true;
#endif
if (port <= 0)
{
return false;
}
catch { }
}

/// <summary>
/// Stop the local HTTP server by finding the process listening on the configured port
/// </summary>
public bool StopLocalHttpServer()
{
return StopLocalHttpServerInternal(quiet: false);
return StopLocalHttpServerInternal(quiet: true, portOverride: port, allowNonLocalUrl: true);
}

public bool IsLocalHttpServerRunning()
Expand Down Expand Up @@ -653,10 +597,10 @@ public bool IsLocalHttpServerRunning()
}
}

private bool StopLocalHttpServerInternal(bool quiet)
private bool StopLocalHttpServerInternal(bool quiet, int? portOverride = null, bool allowNonLocalUrl = false)
{
string httpUrl = HttpEndpointUtility.GetBaseUrl();
if (!IsLocalUrl(httpUrl))
if (!allowNonLocalUrl && !IsLocalUrl(httpUrl))
{
if (!quiet)
{
Expand All @@ -667,8 +611,16 @@ private bool StopLocalHttpServerInternal(bool quiet)

try
{
var uri = new Uri(httpUrl);
int port = uri.Port;
int port = 0;
if (portOverride.HasValue)
{
port = portOverride.Value;
}
else
{
var uri = new Uri(httpUrl);
port = uri.Port;
}

if (port <= 0)
{
Expand All @@ -690,19 +642,27 @@ private bool StopLocalHttpServerInternal(bool quiet)
// validate and terminate exactly that PID.
if (TryGetLocalHttpServerHandshake(out var pidFilePath, out var instanceToken))
{
// If we have a handshake, we intentionally avoid the "kill by port heuristics" path.
// This keeps semantics tight: only stop what Unity started.
// Prefer deterministic stop when Unity started the server (pidfile+token).
// If the pidfile isn't available yet (fast quit after start), we can optionally fall back
// to port-based heuristics when a port override was supplied (managed-stop path).
if (!TryReadPidFromPidFile(pidFilePath, out var pidFromFile) || pidFromFile <= 0)
{
if (!quiet)
if (!portOverride.HasValue)
{
McpLog.Warn(
$"Cannot stop local HTTP server on port {port}: pidfile not available yet at '{pidFilePath}'. " +
"If you just started the server, wait a moment and try again.");
if (!quiet)
{
McpLog.Warn(
$"Cannot stop local HTTP server on port {port}: pidfile not available yet at '{pidFilePath}'. " +
"If you just started the server, wait a moment and try again.");
}
return false;
}
return false;
}

// Managed-stop fallback: proceed with port-based heuristics below.
// We intentionally do NOT clear handshake state here; it will be cleared if we successfully
// stop a server process and/or the port is freed.
}
else
{
// Never kill Unity/Hub.
if (unityPid > 0 && pidFromFile == unityPid)
Expand Down Expand Up @@ -770,32 +730,6 @@ private bool StopLocalHttpServerInternal(bool quiet)
}
}

// If Unity started a local server process in this editor session, try to terminate it first.
// (We still fall back to port-based termination for robustness.)
lock (LocalHttpServerProcessLock)
{
try
{
if (LocalHttpServerProcess != null && !LocalHttpServerProcess.HasExited)
{
int pidToKill = LocalHttpServerProcess.Id;
if (unityPid <= 0 || pidToKill != unityPid)
{
if (TerminateProcess(pidToKill))
{
stoppedAny = true;
}
}
}
}
catch { }
finally
{
try { LocalHttpServerProcess?.Dispose(); } catch { }
LocalHttpServerProcess = null;
}
}

var pids = GetListeningProcessIdsForPort(port);
if (pids.Count == 0)
{
Expand Down Expand Up @@ -923,6 +857,10 @@ private bool StopLocalHttpServerInternal(bool quiet)
}
}

if (stoppedAny)
{
ClearLocalServerPidTracking();
}
return stoppedAny;
}
catch (Exception ex)
Expand All @@ -948,7 +886,11 @@ private static bool TryGetUnixProcessArgs(int pid, out string argsLower)
string psPath = "/bin/ps";
if (!File.Exists(psPath)) psPath = "ps";

ExecPath.TryRun(psPath, $"-p {pid} -ww -o args=", Application.dataPath, out var stdout, out var stderr, 5000);
bool ok = ExecPath.TryRun(psPath, $"-p {pid} -ww -o args=", Application.dataPath, out var stdout, out var stderr, 5000);
if (!ok && string.IsNullOrWhiteSpace(stdout))
{
return false;
}
string combined = ((stdout ?? string.Empty) + "\n" + (stderr ?? string.Empty)).Trim();
if (string.IsNullOrEmpty(combined)) return false;
// Normalize for matching to tolerate ps wrapping/newlines.
Expand All @@ -961,6 +903,38 @@ private static bool TryGetUnixProcessArgs(int pid, out string argsLower)
}
}

private static bool TryGetPortFromPidFilePath(string pidFilePath, out int port)
{
port = 0;
if (string.IsNullOrEmpty(pidFilePath))
{
return false;
}

try
{
string fileName = Path.GetFileNameWithoutExtension(pidFilePath);
if (string.IsNullOrEmpty(fileName))
{
return false;
}

const string prefix = "mcp_http_";
if (!fileName.StartsWith(prefix, StringComparison.OrdinalIgnoreCase))
{
return false;
}

string portText = fileName.Substring(prefix.Length);
return int.TryParse(portText, out port) && port > 0;
}
catch
{
port = 0;
return false;
}
}

private List<int> GetListeningProcessIdsForPort(int port)
{
var results = new List<int>();
Expand Down
Loading