Skip to content

Automate browser based workflows with AI

feat(SKY-12404): log which app (Claude, Cursor, Hermes) each MCP session comes from (#7383)

Marc Kelechava9c53dd89744e
diff --git a/skyvern/cli/mcp_tools/telemetry.py b/skyvern/cli/mcp_tools/telemetry.py
index 05fbe1bff..19d64b31f 100644
--- a/skyvern/cli/mcp_tools/telemetry.py
+++ b/skyvern/cli/mcp_tools/telemetry.py
@@ -5,13 +5,29 @@ from contextlib import suppress
from dataclasses import dataclass
from typing import Any, Literal
+import structlog
from fastmcp.server.dependencies import get_http_request
from fastmcp.server.middleware import CallNext, Middleware, MiddlewareContext
from skyvern import analytics
+LOG = structlog.get_logger(__name__)
+
MCPServerMode = Literal["embedded", "local_cli", "cloud_hosted"]
+UNKNOWN_MCP_CLIENT = "unknown"
+
+_MAX_CLIENT_INFO_CHARS = 200
+
+
+def _sanitize_client_info_value(value: str) -> str:
+ # Bound before escaping so a huge client-controlled string does not
+ # allocate an arbitrarily large intermediate during `.replace()`.
+ sanitized = value[: _MAX_CLIENT_INFO_CHARS * 2].replace("\r", "\\r").replace("\n", "\\n")
+ if len(sanitized) <= _MAX_CLIENT_INFO_CHARS:
+ return sanitized
+ return f"{sanitized[:_MAX_CLIENT_INFO_CHARS]}... [truncated]"
+
@dataclass(frozen=True)
class MCPRuntimeConfig:
@@ -77,6 +93,30 @@ def _resolve_client_id(context: MiddlewareContext[Any]) -> str | None:
return None
+def _client_info_fields(client_info: Any) -> tuple[str, str] | None:
+ name = getattr(client_info, "name", None)
+ if not isinstance(name, str) or not name:
+ return None
+ version = getattr(client_info, "version", None)
+ if not isinstance(version, str) or not version:
+ version = UNKNOWN_MCP_CLIENT
+ return _sanitize_client_info_value(name), _sanitize_client_info_value(version)
+
+
+def _resolve_client_info(context: MiddlewareContext[Any]) -> tuple[str, str]:
+ """clientInfo from the initialize message, else the session's stored client params.
+
+ Clients may omit or malform clientInfo — fall back to "unknown", never raise.
+ """
+ params = getattr(context.message, "params", None)
+ fields = _client_info_fields(getattr(params, "clientInfo", None))
+ if fields is None and context.fastmcp_context is not None:
+ with suppress(RuntimeError):
+ client_params = getattr(context.fastmcp_context.session, "client_params", None)
+ fields = _client_info_fields(getattr(client_params, "clientInfo", None))
+ return fields or (UNKNOWN_MCP_CLIENT, UNKNOWN_MCP_CLIENT)
+
+
def _content_text_bytes(content_block: Any) -> int:
text = getattr(content_block, "text", None)
if not isinstance(text, str):
@@ -99,6 +139,7 @@ def _capture_mcp_event(
request = _resolve_http_request()
organization_id = _resolve_organization_id(request)
distinct_id, distinct_id_source = _resolve_distinct_id(organization_id)
+ client_name, client_version = _resolve_client_info(context)
data: dict[str, Any] = {
**analytics.analytics_metadata(),
@@ -114,6 +155,8 @@ def _capture_mcp_event(
"request_id": _resolve_request_id(context),
"session_id": _resolve_session_id(context),
"client_id": _resolve_client_id(context),
+ "client_name": client_name,
+ "client_version": client_version,
}
if tool_name is not None:
@@ -165,6 +208,16 @@ class MCPTelemetryMiddleware(Middleware):
_capture_mcp_event("mcp_request", operation="initialize", context=context, ok=False, error=exc)
raise
+ with suppress(Exception):
+ client_name, client_version = _resolve_client_info(context)
+ LOG.info(
+ "mcp_session_initialized",
+ mcp_client_name=client_name,
+ mcp_client_version=client_version,
+ session_id=_resolve_session_id(context),
+ runtime_mode=_runtime_config.server_mode,
+ transport=_runtime_config.transport,
+ )
_capture_mcp_event("mcp_request", operation="initialize", context=context, ok=True)
return result
diff --git a/tests/unit/test_mcp_telemetry.py b/tests/unit/test_mcp_telemetry.py
index 5f1c04a0b..797f41350 100644
--- a/tests/unit/test_mcp_telemetry.py
+++ b/tests/unit/test_mcp_telemetry.py
@@ -223,16 +223,149 @@ async def test_list_tools_emits_protocol_request_telemetry() -> None:
tools = await client.list_tools()
assert tools
- assert any(
- event == "mcp_request" and payload and payload["operation"] == "initialize"
+ initialize_payloads = [
+ payload
for event, payload, _, _, _ in events
- )
+ if event == "mcp_request" and payload and payload["operation"] == "initialize"
+ ]
+ assert len(initialize_payloads) == 1
+ # The in-memory fastmcp Client sends real clientInfo, so this exercises the full dispatch path.
+ assert isinstance(initialize_payloads[0]["client_name"], str)
+ assert initialize_payloads[0]["client_name"] not in ("", "unknown")
+ assert isinstance(initialize_payloads[0]["client_version"], str)
assert any(
event == "mcp_request" and payload and payload["operation"] == "tools/list"
for event, payload, _, _, _ in events
)
+def _initialize_context(params: object) -> MiddlewareContext:
+ return MiddlewareContext(message=SimpleNamespace(params=params), fastmcp_context=None)
+
+
+async def _run_initialize(context: MiddlewareContext) -> dict:
+ payloads: list[dict] = []
+
+ def fake_capture(event: str, data: dict | None = None, **_: object) -> None:
+ payloads.append(data or {})
+
+ async def call_next(_context: MiddlewareContext[object]) -> object:
+ return SimpleNamespace()
+
+ with patch.object(analytics, "capture", side_effect=fake_capture):
+ await MCPTelemetryMiddleware().on_initialize(context, call_next)
+
+ assert len(payloads) == 1
+ return payloads[0]
+
+
+async def test_initialize_captures_client_info() -> None:
+ context = _initialize_context(SimpleNamespace(clientInfo=SimpleNamespace(name="hermes-agent", version="1.2.3")))
+
+ with patch("skyvern.cli.mcp_tools.telemetry.LOG") as log_mock:
+ payload = await _run_initialize(context)
+
+ assert payload["client_name"] == "hermes-agent"
+ assert payload["client_version"] == "1.2.3"
+ log_kwargs = log_mock.info.call_args.kwargs
+ assert log_kwargs["mcp_client_name"] == "hermes-agent"
+ assert log_kwargs["mcp_client_version"] == "1.2.3"
+
+
+async def test_initialize_missing_client_info_defaults_to_unknown() -> None:
+ payload = await _run_initialize(_initialize_context(SimpleNamespace()))
+
+ assert payload["client_name"] == "unknown"
+ assert payload["client_version"] == "unknown"
+
+
+async def test_initialize_malformed_client_info_defaults_to_unknown() -> None:
+ context = _initialize_context(SimpleNamespace(clientInfo=SimpleNamespace(name=123, version=["4.5"])))
+
+ payload = await _run_initialize(context)
+
+ assert payload["client_name"] == "unknown"
+ assert payload["client_version"] == "unknown"
+
+
+async def test_initialize_truncates_oversized_client_info() -> None:
+ context = _initialize_context(SimpleNamespace(clientInfo=SimpleNamespace(name="x" * 10_000, version="1.0")))
+
+ payload = await _run_initialize(context)
+
+ assert payload["client_name"].endswith("... [truncated]")
+ assert len(payload["client_name"]) < 250
+ assert payload["client_version"] == "1.0"
+
+
+async def test_initialize_escapes_newlines_in_client_info() -> None:
+ context = _initialize_context(
+ SimpleNamespace(clientInfo=SimpleNamespace(name="evil\nclient", version="1.0\r\n2.0"))
+ )
+
+ payload = await _run_initialize(context)
+
+ assert payload["client_name"] == "evil\\nclient"
+ assert payload["client_version"] == "1.0\\r\\n2.0"
+
+
+async def test_initialize_survives_log_failure() -> None:
+ context = _initialize_context(SimpleNamespace(clientInfo=SimpleNamespace(name="hermes-agent", version="1.2.3")))
+ payloads: list[dict] = []
+
+ def fake_capture(event: str, data: dict | None = None, **_: object) -> None:
+ payloads.append(data or {})
+
+ async def call_next(_context: MiddlewareContext[object]) -> object:
+ return SimpleNamespace()
+
+ with (
+ patch("skyvern.cli.mcp_tools.telemetry.LOG.info", side_effect=RuntimeError("logger down")),
+ patch.object(analytics, "capture", side_effect=fake_capture),
+ ):
+ result = await MCPTelemetryMiddleware().on_initialize(context, call_next)
+
+ assert result is not None
+ assert len(payloads) == 1
+ assert payloads[0]["ok"] is True
+ assert payloads[0]["client_name"] == "hermes-agent"
+
+
+async def test_tool_call_resolves_client_info_from_session() -> None:
+ payloads: list[dict] = []
+
+ def fake_capture(event: str, data: dict | None = None, **_: object) -> None:
+ payloads.append(data or {})
+
+ fastmcp_context = SimpleNamespace(
+ request_id="req-1",
+ session_id="sess-1",
+ client_id=None,
+ session=SimpleNamespace(
+ client_params=SimpleNamespace(clientInfo=SimpleNamespace(name="cursor", version="0.4"))
+ ),
+ )
+ context = MiddlewareContext(message=SimpleNamespace(name="skyvern_block_schema"), fastmcp_context=fastmcp_context)
+ response = SimpleNamespace(is_error=False, data={"ok": True}, content=[])
+
+ async def call_next(_context: MiddlewareContext[object]) -> object:
+ return response
+
+ with patch.object(analytics, "capture", side_effect=fake_capture):
+ await MCPTelemetryMiddleware().on_call_tool(context, call_next)
+
+ assert len(payloads) == 1
+ assert payloads[0]["client_name"] == "cursor"
+ assert payloads[0]["client_version"] == "0.4"
+
+
@pytest.mark.asyncio
async def test_direct_tool_invocation_does_not_emit_mcp_telemetry() -> None:
with patch.object(analytics, "capture") as capture_mock: