arcade-mcp/libs/arcade-mcp-server/arcade_mcp_server/transports/stdio.py
jottakka fe8ddfd500
[TOO-326] Windows papercuts (#768)
<!-- CURSOR_SUMMARY -->
> [!NOTE]
> **Medium Risk**
> Touches authentication/login flow, credentials-file permissions, and
subprocess lifecycle behavior across platforms; while mostly defensive,
regressions could impact login or process management on Windows/macOS
runners.
> 
> **Overview**
> Improves Windows/cross-platform reliability across the CLI and MCP
server: OAuth login now binds the callback server to `127.0.0.1`, avoids
slow loopback reverse-DNS, adds a configurable callback timeout
(`--timeout` + env default), and opens URLs via a Windows-friendly
`_open_browser` to avoid flashing console windows.
> 
> Centralizes CLI output via a shared `console` that forces UTF-8 on
Windows, standardizes UTF-8 file reads/writes throughout, tightens
credentials-file permissions on Windows using `icacls`, and adds shared
Windows subprocess helpers for **no-window** process creation and
graceful termination (used by `deploy`, MCP reload, and usage-tracking
worker).
> 
> Updates client configuration UX/robustness (Windows AppData resolution
via `platformdirs`, Cursor config path fallbacks + compatibility writes,
overwrite warnings, absolute `uv` path for GUI clients, safer path
display) and improves `deploy` child-process handling to avoid
pipe-buffer deadlocks while giving better debug-aware error messages.
> 
> Expands CI to run tests on Linux/Windows/macOS, adds a no-auth CLI
integration workflow, disables usage tracking in toolkits CI, and adds
extensive regression tests for Windows signals, subprocess cleanup,
UTF-8, and config-path edge cases; bumps `arcade-core` to `4.4.2` and
`arcade-mcp-server` to `1.17.2` (with updated dependency pin).
> 
> <sup>Written by [Cursor
Bugbot](https://cursor.com/dashboard?tab=bugbot) for commit
0fabd8ca1cd647039ba6ddbdf3f7809c330bab9e. This will update automatically
on new commits. Configure
[here](https://cursor.com/dashboard?tab=bugbot).</sup>
<!-- /CURSOR_SUMMARY -->
2026-02-25 13:18:16 -03:00

222 lines
7 KiB
Python

"""
Stdio Transport
Provides stdio (stdin/stdout) transport for MCP communication.
"""
import asyncio
import contextlib
import logging
import queue
import signal
import sys
import threading
import uuid
from collections.abc import AsyncIterator
from typing import Any
from arcade_mcp_server.exceptions import TransportError
from arcade_mcp_server.session import ServerSession
logger = logging.getLogger("arcade.mcp.transports.stdio")
class StdioWriteStream:
"""Write stream implementation for stdio."""
def __init__(self, write_queue: queue.Queue[str | None]):
self.write_queue = write_queue
async def send(self, data: str) -> None:
"""Send data to stdout."""
if not data.endswith("\n"):
data += "\n"
await asyncio.to_thread(self.write_queue.put, data)
class StdioReadStream:
"""Read stream implementation for stdio."""
def __init__(self, read_queue: queue.Queue[str | None]):
self.read_queue = read_queue
self._running = True
def stop(self) -> None:
"""Stop the read stream."""
self._running = False
def __aiter__(self) -> AsyncIterator[str]:
return self
async def __anext__(self) -> str:
if not self._running:
raise StopAsyncIteration
try:
line = await asyncio.to_thread(self.read_queue.get)
except asyncio.CancelledError:
raise StopAsyncIteration
except Exception as e:
logger.exception("Error reading from stdin")
raise TransportError(f"Read error: {e}") from e
if line is None or not self._running:
raise StopAsyncIteration
return line
class StdioTransport:
"""
Stdio transport implementation for stdio communication.
This transport uses stdin/stdout for MCP communication,
suitable for command-line tools and scripts.
"""
def __init__(self, name: str = "stdio"):
"""Initialize stdio transport."""
self.name = name
self.read_queue: queue.Queue[str | None] = queue.Queue()
self.write_queue: queue.Queue[str | None] = queue.Queue()
self.reader_thread: threading.Thread | None = None
self.writer_thread: threading.Thread | None = None
self._shutdown_event = asyncio.Event()
self._running = False
self._sessions: dict[str, ServerSession] = {}
self._stop_task: asyncio.Task[None] | None = None
async def start(self) -> None:
"""Start the transport."""
# Component start is handled here directly
# Start I/O threads
self._running = True
self.reader_thread = threading.Thread(
target=self._reader_loop,
daemon=True,
name=f"{self.name}-reader",
)
self.writer_thread = threading.Thread(
target=self._writer_loop,
daemon=True,
name=f"{self.name}-writer",
)
self.reader_thread.start()
self.writer_thread.start()
# Set up signal handlers
loop = asyncio.get_running_loop()
for sig in (signal.SIGINT, signal.SIGTERM):
try:
loop.add_signal_handler(sig, lambda: asyncio.create_task(self.stop()))
except NotImplementedError:
if sys.platform != "win32":
logger.warning(f"Failed to set up signal handler for {sig}")
if sys.platform == "win32":
# On Windows, asyncio signal handlers don't work but the stdlib
# signal.signal(SIGINT) *does* receive Ctrl+C. Register a
# fallback so that a Ctrl+C schedules a clean stop on the loop.
def _schedule_stop() -> None:
self._stop_task = loop.create_task(self.stop())
def _win_ctrl_c(signum: int, frame: object) -> None:
loop.call_soon_threadsafe(_schedule_stop)
signal.signal(signal.SIGINT, _win_ctrl_c)
async def stop(self) -> None:
"""Stop the transport."""
if not self._running:
return
logger.info("Stopping stdio transport")
self._running = False
# Signal threads to stop
self.read_queue.put(None)
self.write_queue.put(None)
# Wait for threads to finish
if self.reader_thread and self.reader_thread.is_alive():
self.reader_thread.join(timeout=1.0)
if self.writer_thread and self.writer_thread.is_alive():
self.writer_thread.join(timeout=1.0)
# Set shutdown event
self._shutdown_event.set()
def _reader_loop(self) -> None:
"""Reader thread loop."""
try:
for line in sys.stdin:
if not self._running:
break
self.read_queue.put(line.strip())
except Exception:
logger.exception("Error in reader thread")
finally:
self.read_queue.put(None) # Signal EOF
def _writer_loop(self) -> None:
"""Writer thread loop."""
try:
while self._running:
msg = self.write_queue.get()
if msg is None:
break
sys.stdout.write(msg)
sys.stdout.flush()
except Exception:
logger.exception("Error in writer thread")
@contextlib.asynccontextmanager
async def connect_session(self, **options: Any) -> AsyncIterator[ServerSession]:
"""
Create a stdio session.
Since stdio is inherently single-session, this will fail
if a session is already active.
"""
# Check if already have a session
sessions = await self.list_sessions()
if sessions:
raise TransportError("Stdio transport only supports one session")
# Create session
session_id = str(uuid.uuid4())
read_stream = StdioReadStream(self.read_queue)
write_stream = StdioWriteStream(self.write_queue)
init_options = {"transport_type": "stdio", **options}
session = ServerSession(
server=None, # set by the caller using run_connection; not used here
session_id=session_id,
read_stream=read_stream,
write_stream=write_stream,
init_options=init_options,
stateless=True,
)
# Register session
await self.register_session(session)
try:
yield session
finally:
# Cleanup
read_stream.stop()
await self.unregister_session(session_id)
async def wait_for_shutdown(self) -> None:
"""Wait for the transport to shut down."""
await self._shutdown_event.wait()
# Minimal session registry to support connect_session lifecycle
async def list_sessions(self) -> list[str]:
return list(self._sessions.keys())
async def register_session(self, session: ServerSession) -> None:
self._sessions[session.session_id] = session
async def unregister_session(self, session_id: str) -> None:
self._sessions.pop(session_id, None)