| 123456789101112131415161718192021222324252627282930313233343536373839404142434445464748495051525354555657585960616263646566676869707172737475767778798081828384858687888990919293949596979899100101102103104105106107108109110111112113114115116117118119120121122123124125126127128129130131132133134135136137138139140141142143144145146147148149150151152153154155156157158159160161162163164165166167168169170171172173174175176177178179180181182183184185186187188189190191192193194195196197198199200201202203204205206207208209210211212213214215216217218219220221222223224225226227228229230231232233234235236237238239240241242243244245246247248249250251252253254255256257258259260261262263264265266267268269270271272273274275276277278279280281282283284285286287288289290291292293294295296297298299300301302303304305306307308309310311312313314315316317318319320321322323324325326327328329330331332333334335336337338339340341342343344345346347348349350351352353354355356357358359360361362363364365366367368369370371372373374375376377378379380381382383384385386387388389390391392393394395396397398399400401402403404405406407408409410411412413414415416417418419420421422423424425426427428429430431432433434435436437438439440441442443444445446447448449450451452453454455456457458459460461462463464465466467468469470471472473474475476477478479480481482483484485486487488489490491492493494495496497498499500501502503504505506507508509510511512513514515516517518519520521522523524525526527528529530531532533534535536537538539540541542543544545546547548549550551552553554555556557558559560561562563564565566567568569570571572573574575576577578579580581582583584585586587588589590591592593594595596597598599600601602603604605606607608609610611612613614615616617618619620621622623624625626627628629630631632633634635636637638639640641642643644645646647648649650651652653654 |
- """Registering a connected (or schema-cached) MCP server's tools into the tool registry:
- include/exclude filtering, trust-tier metadata capture, utility-tool selection, name-collision
- resolution and the schema-cache write-through. Both entry points (``_register_server_tools``
- live, ``_register_from_cache_sync`` lazy) build ``_Candidate`` records for ``_register_candidates``."""
- import hashlib
- import json
- import logging
- import threading
- from dataclasses import dataclass
- from types import SimpleNamespace
- from typing import TYPE_CHECKING, Any, Callable, Dict, Iterable, List, Optional
- from tools.mcp_tool_common import _parse_boolish, _core, _resolve_tool_timeout, mcp_field, mcp_server_enabled
- from tools import mcp_tool_config as _config
- from tools import mcp_tool_events as _events
- from tools import mcp_tool_handlers as _handlers
- from tools import mcp_tool_schema as _schema
- from tools.mcp_tool_handlers import (
- _make_check_fn, _make_get_prompt_handler, _make_list_prompts_handler,
- _make_list_resources_handler, _make_read_resource_handler)
- from tools.mcp_tool_schema import (
- _UTILITY_CAPABILITY_ATTRS, _build_utility_schemas, _normalize_name_filter, matches_name_filter)
- from tools.mcp_tool_scope import _key_name, _key_scope, _resolve_server_key, _server_key
- if TYPE_CHECKING: # pragma: no cover
- from tools.mcp_tool import MCPServerTask
- logger = logging.getLogger("tools.mcp_tool")
- _SCOPE_REFRESH_LOCKS = tuple(threading.RLock() for _ in range(16))
- _UTILITY_ORIGIN_PREFIX = "generated utility "
- # Utility tool key -> handler factory; each takes (server_name, tool_timeout).
- _UTILITY_HANDLER_FACTORIES = {
- "list_resources": _make_list_resources_handler, "read_resource": _make_read_resource_handler,
- "list_prompts": _make_list_prompts_handler, "get_prompt": _make_get_prompt_handler,
- "list_event_types": _events._make_list_event_types_handler, "subscribe_event": _events._make_subscribe_event_handler,
- "unsubscribe_event": _events._make_unsubscribe_event_handler}
- def _normalize_server_trust(value: Any) -> str:
- """Config ``trust`` -> tier. None -> ``full`` (compat default); unrecognized -> ``untrusted`` (fail closed)."""
- if value is None:
- return _core._TRUST_FULL
- text = str(value).strip().lower()
- if text in (_core._TRUST_FULL, _core._TRUST_UNTRUSTED):
- return text
- logger.warning("MCP trust: unrecognized trust value %r — treating as 'untrusted' (valid values: full, untrusted)",
- value)
- return _core._TRUST_UNTRUSTED
- def _annotation_read_only_hint(mcp_tool: Any) -> bool:
- """True only when annotations (SDK object or cache dict) carry an exact ``True`` read-only hint;
- unknown = write-capable. mcp 2.x exposes the attribute as ``read_only_hint`` (camelCase is only a
- serialization alias), so reading camelCase alone gated every read on an untrusted server."""
- annotations = getattr(mcp_tool, "annotations", None)
- if isinstance(annotations, dict):
- hint = annotations.get("readOnlyHint", annotations.get("read_only_hint"))
- else:
- hint = mcp_field(annotations, "read_only_hint", "readOnlyHint")
- return hint is True
- def _record_cost_policy(server_name: str, config: dict, key) -> None:
- """Declared ``tool_costs``/``spend_limit`` for *key*. Load-time validation already dropped malformed
- entries (``_filter_suspicious_mcp_servers``); a direct caller's bad table still fails loudly. Caller holds
- ``_core._lock``."""
- from tools.mcp_tool_costs import config_cost_policy
- policy = config_cost_policy(server_name, config)
- if policy is None:
- _core._server_cost_policies.pop(key, None)
- else:
- _core._server_cost_policies[key] = policy
- def _record_tool_trust_metadata(server_name: str, config: dict, tools: list[Any], key=None) -> None:
- """Capture per-server trust and per-tool readOnlyHint at discovery — the security boundary: the call-time gate
- classifies from data we control, never re-read server-supplied state. *key* is the connection (default: the
- registering profile's own); the ``trust`` policy is recorded under it for the profile that owns it — an
- adopting profile records its own policy in ``_record_scope_trust``."""
- with _core._lock:
- if key is None:
- key = _server_key(server_name)
- _core._server_trust_levels[key] = _normalize_server_trust((config or {}).get("trust"))
- _record_cost_policy(server_name, config, key)
- hints = _core._tool_read_only_hints.setdefault(key, {})
- hints.update({t.name: _annotation_read_only_hint(t) for t in tools if getattr(t, "name", None)})
- def _warn_unknown_cost_keys(server_name: str, key, tool_names: list[str]) -> None:
- """Live discovery only: the schema cache omits tools the user's include/exclude filter dropped, so a valid
- cost for a filtered tool would read as unknown there."""
- from tools.mcp_tool_costs import unknown_cost_keys
- if unknown := unknown_cost_keys(_core._server_cost_policies.get(key), tool_names):
- logger.warning("MCP server '%s': tool_costs names %s, which the server does not offer, so those calls "
- "carry no cost and no spend limit. Use the server's own tool names (without Hermes' "
- "'mcp_%s_' prefix).", server_name, unknown, server_name)
- def _record_scope_trust(server_name: str, config: dict, scope: str) -> None:
- """``trust`` (and the cost policy) is the CONSUMING profile's policy, never the connection's: an
- ``untrusted`` profile that adopts a ``full`` profile's live connection must still be asked before every
- write-capable call."""
- with _core._lock:
- key = _server_key(server_name, scope, current=False)
- _core._server_trust_levels[key] = _normalize_server_trust((config or {}).get("trust"))
- _record_cost_policy(server_name, config, key)
- def _track_mcp_tool_server(tool_name: str, server_name: str) -> None:
- """Remember the exact raw MCP server that registered *tool_name*."""
- with _core._lock:
- _core._mcp_tool_server_names[tool_name] = server_name
- def _forget_mcp_tool_server(tool_name: str) -> None:
- """Forget MCP server provenance for a deregistered tool."""
- with _core._lock:
- _core._mcp_tool_server_names.pop(tool_name, None)
- def _server_key_for_task(server) -> object:
- """Connection key of a live ``MCPServerTask`` (teardown runs on the MCP loop without the
- discovering profile's context, so the key is found by identity, never re-derived)."""
- with _core._lock:
- for key, live in _core._servers.items():
- if live is server:
- return key
- return _server_key(server.name)
- def _deregister_mcp_tool_all_scopes(server, tool_name: str) -> None:
- """Deregister one server tool from every profile overlay that owns it. *server* is the
- live task or a connection key."""
- from tools.registry import registry
- key = server if isinstance(server, (str, tuple)) else _server_key_for_task(server)
- with _core._lock:
- scopes = set(_core._server_tool_scopes.get(key, ()))
- if not scopes:
- scopes = {_core._server_registry_scope(key)}
- for scope in scopes:
- registry.deregister(tool_name, scope=scope)
- _forget_mcp_tool_server(tool_name)
- _restore_server_toolset_alias(key)
- def _restore_server_toolset_alias(key) -> None:
- """Keep the process-global alias while any profile still owns tools of a server with this
- name — including another profile's same-named connection (the alias is per NAME; the
- registry deregister dropped it after checking only one scope)."""
- from tools.registry import registry
- server_name = _key_name(key)
- with _core._lock:
- owned = [(server, set(_core._server_tool_scopes.get(k, ())))
- for k, server in _core._servers.items() if _key_name(k) == server_name]
- if any(
- registry.snapshot_registration(tool_name, scope=scope) is not None
- for server, scopes in owned for scope in scopes
- for tool_name in getattr(server, "_registered_tool_names", ())
- ):
- registry.register_toolset_alias(server_name, f"mcp-{server_name}")
- def _remove_server_scope(key, scope: str) -> None:
- """Remove one profile's MCP overlay for a shared live connection."""
- from tools.registry import registry
- server_name = _key_name(key)
- for tool_name in registry.get_tool_names_for_toolset(f"mcp-{server_name}"):
- registry.deregister(tool_name, scope=scope)
- with _core._lock:
- scopes = set(_core._server_tool_scopes.get(key, ()))
- scopes.discard(scope)
- if scopes:
- _core._server_tool_scopes[key] = scopes
- else:
- _core._server_tool_scopes.pop(key, None)
- _core._server_trust_levels.pop(_server_key(server_name, scope, current=False), None)
- _core._server_cost_policies.pop(_server_key(server_name, scope, current=False), None)
- _restore_server_toolset_alias(key)
- def _select_utility_schemas(server_name: str, server: "MCPServerTask", config: dict) -> list[dict]:
- """Utility schemas allowed by config (``tools.resources``/``tools.prompts``) and advertised
- capabilities. ``initialize_result.capabilities`` is the truth (sub-object non-None iff the
- family is served); without it fall back to the legacy session-method check, which never
- filters anything since ClientSession defines all four methods."""
- tools_filter = config.get("tools") or {}
- enabled = {f: _parse_boolish(tools_filter.get(f), default=True) for f in ("resources", "prompts")}
- advertised = getattr(getattr(server, "initialize_result", None), "capabilities", None)
- def _skip_reason(handler_key: str) -> Optional[str]:
- family = _UTILITY_CAPABILITY_ATTRS[handler_key]
- if family == "events": # opt-in: the SDK drops the server's ``events`` capability
- return None if _events.events_enabled(config) else "events not enabled"
- if not enabled[family]:
- return f"{family} disabled"
- if advertised is not None:
- if getattr(advertised, family, None) is None:
- return f"server does not advertise '{family}' capability"
- return None
- # Legacy gate (no initialize_result): the ClientSession method shares the handler key.
- return None if hasattr(server.session, handler_key) else f"session lacks {handler_key}"
- selected: list[dict] = []
- for entry in _build_utility_schemas(server_name):
- reason = _skip_reason(entry["handler_key"])
- if reason:
- logger.debug("MCP server '%s': skipping utility '%s' (%s)", server_name, entry["handler_key"], reason)
- else:
- selected.append(entry)
- return selected
- def _existing_tool_names() -> list[str]:
- """Tool names for all connected servers plus lazy (cache-registered) servers, whose tools live only in the registry."""
- scope = _core._mcp_registry_scope()
- if scope is not None:
- from tools.registry import registry
- with _core._lock:
- server_names = [
- _key_name(key) for key in _core._servers
- if _core._server_visible_in_scope(key, scope)
- ]
- server_names.extend(
- _key_name(key) for key in _core._lazy_server_tool_names
- if key not in _core._servers and _core._server_visible_in_scope(key, scope)
- )
- return sorted({
- tool_name
- for server_name in server_names
- for tool_name in registry.get_tool_names_for_toolset(f"mcp-{server_name}")
- })
- names: list[str] = []
- for server in _core._servers.values():
- names.extend(server._registered_tool_names if hasattr(server, "_registered_tool_names")
- else (_schema._convert_mcp_schema(server.name, t)["name"] for t in server._tools))
- with _core._lock:
- names.extend(n for key, tool_names in _core._lazy_server_tool_names.items()
- if key not in _core._servers for n in tool_names)
- return names
- def _make_tool_filter(name: str, config: dict) -> Callable[[str], bool]:
- """Include/exclude predicate for a server's tool names: ``tools.include`` is a whitelist (``[]`` = register
- nothing), ``tools.exclude`` a blacklist; entries are exact names or fnmatch globs; include wins over exclude."""
- tools_filter = config.get("tools") or {}
- # Selective tool loading: honour include/exclude lists from config. Rules (matching issue #690 spec,
- # extended with glob support): tools.include — whitelist: only matching tool names are registered
- # tools.exclude — blacklist: all tools EXCEPT matching ones are registered entries may be exact names or
- # fnmatch globs (e.g. "*_radar_*") include takes precedence over exclude include: [] → register nothing
- # (an explicit empty whitelist, as written by the install checklist's "uncheck everything" path) Neither
- # set → register all tools (backward-compatible default)
- include_raw = tools_filter.get("include")
- include_set = _normalize_name_filter(include_raw, f"mcp_servers.{name}.tools.include")
- exclude_set = _normalize_name_filter(tools_filter.get("exclude"), f"mcp_servers.{name}.tools.exclude")
- if isinstance(include_raw, (str, list, tuple, set)):
- return lambda tool_name: matches_name_filter(tool_name, include_set)
- return lambda tool_name: not (exclude_set and matches_name_filter(tool_name, exclude_set))
- def _cached_tools(raws: Iterable[Any]) -> list[SimpleNamespace]:
- """Schema-cache rows -> stand-ins for MCP Tool objects; rows that are not dicts or lack a name
- are dropped. Missing or non-dict ``annotations`` (older cache files) fail closed to write-capable."""
- return [SimpleNamespace(name=raw["name"], description=raw.get("description") or "",
- inputSchema=raw["inputSchema"] if isinstance(raw.get("inputSchema"), dict) else {},
- annotations=raw["annotations"] if isinstance(raw.get("annotations"), dict) else None)
- for raw in raws if isinstance(raw, dict) and raw.get("name")]
- @dataclass
- class _Candidate:
- """One registration attempt (native tool or generated utility); ``origin`` is the provenance text in diagnostics."""
- registry_name: str
- origin: str
- schema: dict
- handler: Callable
- @property
- def is_utility(self) -> bool:
- return self.origin.startswith(_UTILITY_ORIGIN_PREFIX)
- def _tool_candidates(name: str, tools: Iterable[Any], should_register: Callable[[str], bool],
- tool_timeout) -> list[_Candidate]:
- """Native tools (live SDK objects or cache stand-ins) -> candidates. The injection scan runs on
- BOTH paths: the cache file is user-writable JSON."""
- out: list[_Candidate] = []
- for t in tools:
- if not should_register(t.name):
- logger.debug("MCP server '%s': skipping tool '%s' (filtered by config)", name, t.name)
- continue
- _schema._scan_mcp_description(name, t.name, t.description or "")
- schema = _schema._convert_mcp_schema(name, t)
- handler = _handlers._make_tool_handler(name, t.name, tool_timeout, native_images=True)
- out.append(_Candidate(schema["name"], f"tool {t.name!r}", schema, handler))
- return out
- def _utility_candidates(name: str, entries: Iterable[Any], tool_timeout) -> list[_Candidate]:
- """``{schema, handler_key}`` rows (live selection or cache) -> candidates; malformed rows dropped."""
- out: list[_Candidate] = []
- for raw in entries:
- schema, key = (raw.get("schema"), raw.get("handler_key")) if isinstance(raw, dict) else (None, None)
- if isinstance(schema, dict) and key in _UTILITY_HANDLER_FACTORIES and schema.get("name"):
- out.append(_Candidate(schema["name"], f"{_UTILITY_ORIGIN_PREFIX}{key!r}", schema,
- _UTILITY_HANDLER_FACTORIES[key](name, tool_timeout)))
- return out
- def _resolve_name_collisions(name: str, candidates: list[_Candidate]) -> list[_Candidate]:
- """Preflight name collisions: exact duplicates dropped silently; a utility normalizing onto
- a native tool's name is shadowed (native wins); any other multi-origin collision skips every
- colliding entry (fail closed). Returns survivors in order."""
- unique: list[_Candidate] = []
- origins_by_name: dict[str, set[str]] = {}
- for c in candidates:
- origins = origins_by_name.setdefault(c.registry_name, set())
- if c.origin in origins:
- logger.debug("MCP server '%s': duplicate registration candidate %s for '%s'; keeping one",
- name, c.origin, c.registry_name)
- continue
- origins.add(c.origin)
- unique.append(c)
- ambiguous: dict[str, list[str]] = {}
- shadowed: set[tuple[str, str]] = set()
- # A generated resource/prompt utility that normalizes onto a server-native tool's name must not knock
- # that native tool out of the registry: the native tool is the capability the user connected the server
- # for, while the generated utility (read_resource/list_resources/list_prompts/get_prompt) is optional
- # sugar that only matters when the server exposes no such tool of its own (#87112). Resolve that
- # specific collision in favour of the native tool — keep it, drop the shadowed utility — and fall back
- # to the conservative skip-everything only for genuinely ambiguous collisions (two or more native tools
- # normalizing to one name, which we cannot disambiguate). The four utility keys are distinct, so a
- # colliding set holds at most one utility origin.
- for registry_name, origins in origins_by_name.items():
- if len(origins) <= 1:
- continue
- utility_origins = sorted(o for o in origins if o.startswith(_UTILITY_ORIGIN_PREFIX))
- native_origins = sorted(origins - set(utility_origins))
- if len(native_origins) == 1 and utility_origins:
- shadowed.update((registry_name, o) for o in utility_origins)
- logger.info(
- "MCP server '%s': generated utility %s normalizes onto server-native %s — keeping the native tool "
- "and dropping the utility (the utility only applies when the server has no such tool of its own)",
- name, ", ".join(utility_origins), native_origins[0])
- else:
- ambiguous[registry_name] = sorted(origins)
- for registry_name, origins in sorted(ambiguous.items()):
- logger.error("MCP server '%s': name normalization collision for '%s' from %s; skipping every colliding "
- "entry instead of choosing an arbitrary handler", name, registry_name, ", ".join(origins))
- return [c for c in unique if c.registry_name not in ambiguous and (c.registry_name, c.origin) not in shadowed]
- def _register_candidates(name: str, candidates: list[_Candidate], *, check_fn: Callable,
- scope: Callable[[], Optional[str]], lazy: bool, key=None, execution_timeout=None) -> list[str]:
- """Register candidates under toolset ``mcp-{name}``; returns the names that landed. The
- ownership pre-check is advisory (servers connect in parallel): ``registry.register()`` is
- the atomic gate and its verdict is re-read after every call. *key* is the connection whose
- ``_server_tool_scopes`` records the registering scope (default: this scope's own)."""
- from tools.registry import registry
- toolset_name = f"mcp-{name}"
- registered: list[str] = []
- scope_value = scope()
- if key is None:
- key = _server_key(name, scope_value, current=False)
- for c in candidates:
- existing_toolset = registry.get_toolset_for_tool(c.registry_name)
- if existing_toolset and existing_toolset != toolset_name: # foreign owner: skip, preserve it
- if lazy:
- if not c.is_utility:
- logger.warning("MCP server '%s' (lazy): cached tool '%s' collides with toolset '%s' — skipping",
- name, c.registry_name, existing_toolset)
- elif existing_toolset.startswith("mcp-"):
- logger.error("MCP server '%s': %s normalizes to '%s', already owned by MCP toolset '%s' — skipping to "
- "preserve the existing owner", name, c.origin, c.registry_name, existing_toolset)
- else:
- logger.warning("MCP server '%s': %s (→ '%s') collides with built-in tool in toolset '%s' — skipping to "
- "preserve built-in", name, c.origin, c.registry_name, existing_toolset)
- continue
- registry.register(
- name=c.registry_name, toolset=toolset_name, schema=c.schema, handler=c.handler, check_fn=check_fn,
- is_async=False, description=c.schema.get("description") or "", scope=scope_value,
- execution_timeout=execution_timeout)
- if registry.get_toolset_for_tool(c.registry_name) == toolset_name:
- _track_mcp_tool_server(c.registry_name, name)
- if scope_value is not None:
- with _core._lock:
- _core._server_tool_scopes.setdefault(key, set()).add(scope_value)
- registered.append(c.registry_name)
- elif not lazy:
- logger.error("MCP server '%s': registration of %s as '%s' was rejected by the registry; "
- "skipping provenance/count updates", name, c.origin, c.registry_name)
- if registered:
- registry.register_toolset_alias(name, toolset_name)
- return registered
- def _write_schema_cache(name: str, server: "MCPServerTask", config: dict, should_register) -> None:
- """Write-through: persist the manifest so the next startup registers this server lazily (no spawn). Never raises."""
- try:
- # Write-through (#56832): refresh the on-disk schema cache after a live connect so the next startup
- # can lazily register this server without spawning it. Cache failures never break registration.
- from tools.mcp_schema_cache import config_fingerprint, write_cache_entry
- tools_payload = []
- for t in server._tools:
- if not should_register(t.name):
- continue
- # mcp 2.0 renamed every Tool model field to snake_case and left camelCase as a
- # *serialization* alias only, which pydantic does not apply to attribute access: a bare
- # camelCase getattr returns None on 2.x instead of raising. That silently wrote an empty
- # ``inputSchema`` into the schema cache on every write-through, so a ``lazy: true`` server
- # registered from cache with every parameter stripped. ``mcp_field`` reads both spellings.
- schema_obj = mcp_field(t, "input_schema", "inputSchema")
- tools_payload.append({
- "name": t.name, "description": t.description or "",
- "inputSchema": schema_obj if isinstance(schema_obj, dict) else {},
- "annotations": {"readOnlyHint": _annotation_read_only_hint(t)}, # lazy path trust-gates identically
- })
- utility_payload = [{"schema": e["schema"], "handler_key": e["handler_key"]}
- for e in _select_utility_schemas(name, server, config)]
- cache_meta = getattr(server, "_list_cache_meta", None) or {}
- write_cache_entry(name, config_fingerprint(config), tools=tools_payload, utility_tools=utility_payload,
- ttl_ms=cache_meta.get("ttl_ms"), cache_scope=cache_meta.get("cache_scope"))
- except Exception as exc:
- logger.debug("MCP schema cache write failed for '%s': %s", name, exc)
- def _register_server_tools(name: str, server: "MCPServerTask", config: dict) -> list[str]:
- """Register a connected server's tools plus utilities (initial discovery and list_changed
- refresh); returns the names. Toolset aliases derive from the live registry, not
- ``toolsets.TOOLSETS``; lossy normalization collisions (``read-file``/``read_file``) fail closed."""
- should_register = _make_tool_filter(name, config)
- key = _server_key_for_task(server)
- _record_tool_trust_metadata(name, config, server._tools, key)
- _warn_unknown_cost_keys(name, key, [t.name for t in server._tools if getattr(t, "name", None)])
- candidates = _tool_candidates(name, server._tools, should_register, server.tool_timeout)
- candidates += _utility_candidates(name, _select_utility_schemas(name, server, config), server.tool_timeout)
- # Judged by the connection's owner scope (the ``(scope, name)`` key the registration below
- # publishes into), never by the bare name resolved in the caller's context.
- if (_core._server_registry_scope(key) or '').startswith('editor-session:'):
- import json
- from hermes_state_runtime import RuntimeStoreError
- manifest = json.dumps({c.registry_name: c.schema for c in candidates}, sort_keys=True)
- frozen = getattr(server, '_editor_frozen_manifest', manifest)
- if manifest != frozen:
- raise RuntimeStoreError('acp_mcp_schema_changed')
- server._editor_frozen_manifest = frozen
- registered = _register_candidates(
- name, _resolve_name_collisions(name, candidates),
- check_fn=_make_check_fn(name), scope=lambda: _core._server_registry_scope(key), lazy=False, key=key,
- execution_timeout=config.get("timeout"))
- if registered and not (_core._server_registry_scope(key) or '').startswith('editor-session:'):
- _write_schema_cache(name, server, config, should_register)
- return registered
- def _connection_identity(config: dict) -> tuple:
- """What makes one live connection reusable for another profile: the route fingerprint PLUS
- everything that authenticates or secures it (``config_fingerprint`` deliberately excludes
- credentials so the schema cache survives a token rotation). Two profiles pointing at the same URL
- with different headers/env/auth/client certificates/TLS policy are two identities; borrowing
- across them would call tools as the other user, or under the other profile's ``ssl_verify`` /
- ``strict_redirect_headers``."""
- from tools.mcp_schema_cache import config_fingerprint
- def _frozen(value):
- return json.dumps(value or {}, sort_keys=True, default=str)
- return (config_fingerprint(config), _frozen(config.get("env")), _frozen(config.get("headers")),
- _auth_type(config), _frozen(config.get("client_cert")), _frozen(config.get("client_key")),
- config.get("ssl_verify", True), bool(config.get("strict_redirect_headers")))
- def _auth_type(config: dict) -> str:
- return (config.get("auth") or "").lower().strip()
- def _identity_digest(resolved: list) -> str:
- """Only the hash of a connection's resolved inputs is kept: they carry secrets."""
- return hashlib.sha256(json.dumps(resolved, sort_keys=True, default=str).encode()).hexdigest()
- def _adopter_identity_digest(server_name: str, config: dict) -> str | None:
- """Digest of what a connection is opened with that the config does not show, resolved in the
- CURRENT profile's scope by the transport's own resolvers: a stdio child's executable (bare
- ``npx``/``node`` may resolve under the profile's home), env (external secret-source values) and
- default cwd; an HTTP connection's URL and headers after a ``server_json`` live endpoint and
- ``identity_header`` (``value_from: profile``). The transport publishes the digest of the very
- inputs each attempt connects with; an adopter recomputes it here. A resolver failure refuses
- adoption for this server only, never discovery for the whole scope. None is the one refuse
- sentinel: no connectable config, no live endpoint, or a resolver failure."""
- from tools.mcp_tool_transport import LiveEndpointUnavailable, _connect_inputs
- if "url" not in config and not config.get("command"): # the transport refuses it before resolving
- return None
- try:
- inputs, _ = _connect_inputs(server_name, config)
- except LiveEndpointUnavailable: # the transport cannot connect either; never equal to a live one
- return None
- except Exception as exc: # fail closed for this server; the others still adopt
- logger.warning("MCP server '%s': cannot resolve this profile's connection identity (%s); "
- "not adopting another profile's connection", server_name, exc)
- return None
- return _identity_digest(inputs)
- def _same_server_route(server: Any, config: dict, *, cross_profile: bool = False,
- resolved_identity: str | None = None) -> bool:
- """Whether *server* matches *config*. Across profiles the static config is not enough: OAuth
- tokens live in the owner's token store (never reusable), and secret-source env, the profile
- identity header and the default cwd resolve per profile, so the adopter's resolution
- (*resolved_identity*, computed by the caller outside the registry lock; None refuses) must hash
- to what the owner connected with. Within one profile the connection is the profile's: its
- default cwd resolves in the connection task's own context, never per session."""
- if _connection_identity(getattr(server, "_config", {}) or {}) != _connection_identity(config):
- return False
- if not cross_profile:
- return True
- # Identities match, so both sides carry the same normalised auth type.
- recorded = getattr(server, "_resolved_identity", None)
- return (_auth_type(config) != "oauth" and recorded is not None
- and resolved_identity is not None and recorded == resolved_identity)
- def register_connected_into_current_scope(servers: dict) -> int:
- """Serialize shared-scope reconciliation and registration for one discovery pass."""
- scope = _core._mcp_registry_scope()
- if scope is None:
- return 0
- with _SCOPE_REFRESH_LOCKS[hash(scope) % len(_SCOPE_REFRESH_LOCKS)]:
- return _register_connected_into_current_scope(servers)
- def _register_connected_into_current_scope(servers: dict) -> int:
- """Heal the current profile's MCP overlay from already-connected shared servers.
- A shared live connection remains owned by the profile that opened it, but a profile with the
- same route must still receive its callable tool entries. The current profile's config is the
- allowlist, and route fingerprints prevent borrowing a differently-authenticated connection.
- Missing or changed config entries remove only this profile's overlay.
- """
- from tools.registry import registry
- scope = _core._mcp_registry_scope()
- if scope is None:
- return 0
- # Callers that connect a subset (plugin go-live, a connector, orphan re-registration) pass only
- # those names. A name they omit is judged against this profile's own config, or connecting one
- # server would strip every other server's tools from the profile while their connections live on.
- with _core._lock:
- omitted = {_key_name(key) for key, scopes in _core._server_tool_scopes.items()
- if scope in scopes and _key_name(key) not in servers}
- # Only a name another profile holds a connection for reaches a cross-profile comparison.
- foreign = {_key_name(key) for key in _core._servers if _key_scope(key) != scope}
- # Resolving what this profile would connect with does PATH lookups, secret-scope reads and
- # live-endpoint probes: do it only for names that can be compared across profiles, once each,
- # before taking the global registry lock. A foreign key that appears after the snapshot has
- # no digest here and is refused until the next pass. A routed profile reconciles after
- # ``discover_mcp_tools`` released its temporary owner scope (#113746), so the config load and
- # the resolution bind THIS profile's own secret scope; unscoped, a source-tagged secret read
- # would refuse a share whose values are equal.
- from tools.mcp_tool_discovery import _owner_secret_scope
- with _owner_secret_scope():
- profile_servers = _config._load_mcp_config() if omitted else {}
- judged = {**{name: profile_servers.get(name) for name in omitted}, **servers}
- resolved_ids = {name: _adopter_identity_digest(name, config)
- for name, config in judged.items()
- if name in foreign and config is not None and mcp_server_enabled(config)}
- with _core._lock:
- stale = []
- for key, scopes in _core._server_tool_scopes.items():
- if scope not in scopes:
- continue
- name = _key_name(key)
- if name not in judged:
- continue # attached after the config read; the next pass judges it
- server = _core._servers.get(key)
- config = judged[name]
- cross_profile = _key_scope(key) != scope
- if (config is None or not mcp_server_enabled(config) or server is None
- or getattr(server, "session", None) is None
- or not _same_server_route(server, config, cross_profile=cross_profile,
- resolved_identity=resolved_ids.get(name))):
- stale.append(key)
- for key in stale:
- _remove_server_scope(key, scope)
- registered_servers = 0
- for name, config in servers.items():
- if not mcp_server_enabled(config):
- continue
- with _core._lock:
- if _server_key(name, scope, current=False) in _core._servers:
- continue # this profile has its own connection for the name
- # Any other profile's live connection with the same route AND credentials is shareable.
- shared = [(key, live) for key, live in _core._servers.items()
- if _key_name(key) == name and getattr(live, "session", None) is not None
- and _same_server_route(live, config, cross_profile=True,
- resolved_identity=resolved_ids.get(name))]
- if not shared:
- continue
- key, server = shared[0]
- # Visibility for this profile: the owner keeps teardown, this scope sees the connection.
- with _core._lock:
- _core._server_tool_scopes.setdefault(key, set()).add(scope)
- _record_scope_trust(name, config, scope)
- if registry.get_tool_names_for_toolset(f"mcp-{name}"):
- continue
- candidates = _tool_candidates(name, server._tools, _make_tool_filter(name, config), server.tool_timeout)
- candidates += _utility_candidates(
- name, _select_utility_schemas(name, server, config), server.tool_timeout)
- names = _register_candidates(
- name, _resolve_name_collisions(name, candidates),
- check_fn=_make_check_fn(name), scope=lambda: scope, lazy=False, key=key,
- execution_timeout=config.get("timeout"))
- if names:
- registered_servers += 1
- with _core._lock:
- server._registered_tool_names = sorted(
- set(getattr(server, "_registered_tool_names", []) or ()) | set(names))
- return registered_servers
- def _register_from_cache_sync(name: str, config: dict, entry: dict) -> list[str]:
- """Lazy startup: register from a cached manifest with no child process (first real call goes
- through ``_ensure_lazy_server_connected``). Trust metadata is recorded first so the
- call-time gate is identical for live and cached registrations.
- Lazy startup (#56832, design by Vansh5632): tools appear in the registry immediately; the first real
- call routes through ``_get_connected_server_for_call`` → ``_ensure_lazy_server_connected``.
- """
- from tools.mcp_schema_cache import config_fingerprint, tools_from_cache_entry, utility_tools_from_cache_entry
- tool_timeout = _resolve_tool_timeout(config)
- cached_tools = _cached_tools(tools_from_cache_entry(entry))
- _record_tool_trust_metadata(name, config, cached_tools)
- candidates = _tool_candidates(name, cached_tools, _make_tool_filter(name, config), tool_timeout)
- candidates += _utility_candidates(name, utility_tools_from_cache_entry(entry), tool_timeout)
- registered = _register_candidates(
- name, candidates, check_fn=_make_check_fn(name), scope=_core._mcp_registry_scope, lazy=True,
- execution_timeout=config.get("timeout"))
- if registered:
- with _core._lock:
- key = _server_key(name)
- _core._lazy_server_configs[key] = dict(config)
- _core._lazy_server_fingerprints[key] = config_fingerprint(config)
- _core._lazy_server_tool_names[key] = list(registered)
- logger.info("MCP server '%s' (lazy): registered %d tool(s) from schema cache", name, len(registered))
- return registered
|