hermes_mcp.py 12 KB

123456789101112131415161718192021222324252627282930313233343536373839404142434445464748495051525354555657585960616263646566676869707172737475767778798081828384858687888990919293949596979899100101102103104105106107108109110111112113114115116117118119120121122123124125126127128129130131132133134135136137138139140141142143144145146147148149150151152153154155156157158159160161162163164165166167168169170171172173174175176177178179180181182183184185186187188189190191192193194195196197198199200201202203204205206207208209210211212213214215216217218219220221222223224225226227228229230231232233234235236237238239240241242243244245246247248249250251252253254255256257258259260261262263264265266267268269270
  1. """Hermes-native MCP management for Yaovi (config.yaml ``mcp_servers``), via the service bridge.
  2. Reuses Hermes's own helpers (``hermes_cli.mcp_config`` save/remove/probe/validation, the dashboard
  3. MCP OAuth flow). The dashboard routers themselves depend on the TUI gateway, which the embedded
  4. runtime does not ship, so the thin route bodies are re-expressed here.
  5. Env/header values live in the service's owner-only config.yaml. Public summaries stay redacted;
  6. old env references remain readable and are converted only when that service is explicitly saved.
  7. """
  8. from __future__ import annotations
  9. import os
  10. import re
  11. import secrets
  12. import threading
  13. import time
  14. from typing import Any
  15. NAME_RE = re.compile(r"^[A-Za-z0-9][A-Za-z0-9_-]{0,63}$")
  16. ENV_KEY_RE = re.compile(r"^[A-Za-z_][A-Za-z0-9_]{0,99}$")
  17. REF_RE = re.compile(r"\$\{[^}]+\}")
  18. # Yaovi-only key: run the stdio server inside the Bot's shared Linux desktop (compiled by Yaovi).
  19. YAOVI_KEYS = ("yaovi_location",)
  20. class McpError(Exception):
  21. def __init__(self, status: int, message: str):
  22. super().__init__(message)
  23. self.status = status
  24. def _servers() -> dict[str, dict]:
  25. from hermes_cli.config import read_raw_config
  26. servers = (read_raw_config() or {}).get("mcp_servers") or {}
  27. return {k: v for k, v in servers.items() if isinstance(v, dict)} if isinstance(servers, dict) else {}
  28. def _secret_var(server: str, key: str, header: bool = False) -> str:
  29. slug = re.sub(r"[^A-Za-z0-9]+", "_", server).upper().strip("_")
  30. k = re.sub(r"[^A-Za-z0-9]+", "_", key).upper().strip("_")
  31. return f"MCP_{slug}_{'HDR_' if header else ''}{k}"[:120]
  32. def _summary(name: str, cfg: dict) -> dict:
  33. from hermes_cli.web_server_mcp import _mcp_server_summary
  34. out = _mcp_server_summary(name, cfg)
  35. headers = cfg.get("headers") or {}
  36. out["header_keys"] = sorted(headers) if isinstance(headers, dict) else []
  37. out["env_keys"] = sorted((cfg.get("env") or {}).keys())
  38. out["yaovi_location"] = cfg.get("yaovi_location") or "server"
  39. tools = cfg.get("tools") if isinstance(cfg.get("tools"), dict) else {}
  40. out["include"] = tools.get("include")
  41. out["exclude"] = tools.get("exclude")
  42. return out
  43. def op_list(args: dict) -> dict:
  44. return {"servers": [_summary(n, c) for n, c in sorted(_servers().items())]}
  45. def op_raw(args: dict) -> dict:
  46. """Private Host compilation input. May contain actual values; never expose or log it."""
  47. return {"servers": _servers()}
  48. def _secrets(server: str, incoming: Any, previous: dict, header: bool) -> dict:
  49. from hermes_cli.config import get_env_value, get_hermes_home
  50. from agent.secret_scope import load_env_file
  51. from pathlib import Path
  52. if not isinstance(incoming, dict):
  53. raise McpError(400, "env/headers 必须是对象")
  54. out = {}
  55. for key, value in incoming.items():
  56. if not isinstance(key, str) or not (ENV_KEY_RE.match(key) if not header else re.match(r"^[A-Za-z0-9-]{1,100}$", key)):
  57. raise McpError(400, f"无效的键名:{key}")
  58. if value is True:
  59. if key not in previous:
  60. raise McpError(400, f"{key} 没有已保存的值")
  61. value = previous[key]
  62. var = _secret_var(server, key, header)
  63. if value == "${" + var + "}":
  64. # Read the current home's file before inherited/process values. Bot homes may
  65. # retain an old reference to their system parent's automatic variable.
  66. inherited = os.environ.get("YAOVI_HERMES_ROOT", "")
  67. values = load_env_file(Path(inherited) / ".env") if inherited else {}
  68. values.update(load_env_file(get_hermes_home() / ".env"))
  69. value = values[var] if var in values else get_env_value(var)
  70. if value is None or (isinstance(value, str) and REF_RE.search(value)):
  71. raise McpError(400, f"服务 {server} 的 {key} 已保存引用无法解析")
  72. if not isinstance(value, str) or len(value) > 16000:
  73. raise McpError(400, f"{key} 的值无效")
  74. out[key] = value
  75. return out
  76. def _require_writable() -> None:
  77. from hermes_cli.config import is_managed
  78. if is_managed():
  79. raise McpError(403, "托管配置不允许修改 MCP 服务")
  80. def op_upsert(args: dict) -> dict:
  81. from hermes_cli.mcp_config import _save_mcp_server
  82. _require_writable()
  83. name = str(args.get("name") or "")
  84. if not NAME_RE.match(name):
  85. raise McpError(400, "服务名称只能包含字母、数字、- 和 _")
  86. previous = _servers().get(name) or {}
  87. if args.get("create") and previous:
  88. raise McpError(409, f"服务 {name} 已存在")
  89. transport = args.get("transport") or ("http" if args.get("url") else "stdio")
  90. cfg: dict[str, Any] = {}
  91. if transport == "http":
  92. url = str(args.get("url") or "")
  93. if not re.match(r"^https?://", url):
  94. raise McpError(400, "HTTP MCP 需要 http(s) 地址")
  95. cfg["url"] = url
  96. headers = _secrets(name, args.get("headers", {}), previous.get("headers") or {}, True)
  97. if headers:
  98. cfg["headers"] = headers
  99. if args.get("auth") == "oauth":
  100. cfg["auth"] = "oauth"
  101. else:
  102. command = str(args.get("command") or "").strip()
  103. if not command:
  104. raise McpError(400, "stdio MCP 需要命令")
  105. cfg["command"] = command
  106. cfg["args"] = [str(a) for a in (args.get("args") or [])][:64]
  107. env = _secrets(name, args.get("env", {}), previous.get("env") or {}, False)
  108. if env:
  109. cfg["env"] = env
  110. if args.get("yaovi_location") == "virtual":
  111. cfg["yaovi_location"] = "virtual"
  112. tools: dict[str, Any] = {}
  113. for key in ("include", "exclude"):
  114. value = args.get(key)
  115. if value is not None:
  116. if not isinstance(value, list) or not all(isinstance(v, str) and 0 < len(v) <= 128 for v in value):
  117. raise McpError(400, f"{key} 必须是工具名列表")
  118. tools[key] = value[:500]
  119. if tools:
  120. cfg["tools"] = tools
  121. cfg["enabled"] = bool(args.get("enabled", previous.get("enabled", True)))
  122. for keep in ("sampling", "oauth", "timeout", "connect_timeout"):
  123. if keep in previous:
  124. cfg[keep] = previous[keep]
  125. literal_paths = {("mcp_servers", name, field, key)
  126. for field in ("headers", "env") for key, value in cfg.get(field, {}).items()
  127. if not REF_RE.search(value)}
  128. if not _save_mcp_server(name, cfg, literal_paths=literal_paths):
  129. raise McpError(400, f"服务 {name} 的命令或参数被 Hermes 判定为可疑,未保存")
  130. return _summary(name, cfg)
  131. def op_remove(args: dict) -> dict:
  132. from hermes_cli.mcp_config import _remove_mcp_server
  133. _require_writable()
  134. name = str(args.get("name") or "")
  135. if not _remove_mcp_server(name):
  136. raise McpError(404, f"服务 {name} 不存在")
  137. return {"ok": True}
  138. def op_enabled(args: dict) -> dict:
  139. from hermes_cli.config import load_config, save_config
  140. _require_writable()
  141. name = str(args.get("name") or "")
  142. cfg = load_config()
  143. servers = cfg.get("mcp_servers") or {}
  144. if name not in servers:
  145. # A Bot home may switch an inherited system server on/off with a stub override entry.
  146. if not (args.get("override") and NAME_RE.match(name)):
  147. raise McpError(404, f"服务 {name} 不存在")
  148. servers = cfg.setdefault("mcp_servers", servers if isinstance(servers, dict) else {})
  149. servers[name] = {}
  150. servers[name]["enabled"] = bool(args.get("enabled"))
  151. save_config(cfg)
  152. return {"ok": True, "name": name, "enabled": bool(args.get("enabled"))}
  153. def op_test(args: dict) -> dict:
  154. from hermes_cli.mcp_config import _oauth_tokens_present, _probe_single_server, redact_mcp_probe_text
  155. from tools.mcp_tool_config import _interpolate_env_vars
  156. name = str(args.get("name") or "")
  157. cfg = args.get("config") if isinstance(args.get("config"), dict) else _servers().get(name)
  158. if not cfg:
  159. raise McpError(404, f"服务 {name} 不存在")
  160. try:
  161. from hermes_cli.env_loader import load_hermes_dotenv
  162. load_hermes_dotenv()
  163. except Exception:
  164. pass
  165. cfg = {k: v for k, v in _interpolate_env_vars(dict(cfg)).items() if k not in YAOVI_KEYS}
  166. details: dict[str, Any] = {}
  167. from tools.mcp_tool import _ensure_mcp_sdk
  168. if not _ensure_mcp_sdk():
  169. return {"ok": False, "error": "Hermes 运行环境缺少 mcp SDK", "tools": []}
  170. try:
  171. tools = _probe_single_server(name, cfg, connect_timeout=float(args.get("timeout") or 20), details=details)
  172. except Exception as exc:
  173. return {"ok": False, "error": redact_mcp_probe_text(exc), "tools": []}
  174. if cfg.get("auth") == "oauth" and not _oauth_tokens_present(name):
  175. return {"ok": False, "error": "需要先完成 OAuth 授权", "tools": []}
  176. return {"ok": True, "tools": [{"name": t, "description": d} for t, d in tools],
  177. "prompts": details.get("prompts", 0), "resources": details.get("resources", 0)}
  178. # ── MCP OAuth (Hermes dashboard flow; the callback is served by Yaovi and forwarded here) ──
  179. def op_auth_start(args: dict) -> dict:
  180. from hermes_constants import get_hermes_home
  181. from hermes_cli.web_server_mcp import _mcp_oauth_flows, _run_dashboard_mcp_oauth
  182. from tools.mcp_dashboard_oauth import DashboardOAuthFlow, exception_message
  183. name = str(args.get("name") or "")
  184. cfg = _servers().get(name)
  185. if not cfg:
  186. raise McpError(404, f"服务 {name} 不存在")
  187. if not cfg.get("url"):
  188. raise McpError(400, "stdio 服务通过环境变量认证,不使用 OAuth")
  189. redirect = str(args.get("redirectUri") or "")
  190. if not re.match(r"^https?://", redirect):
  191. raise McpError(400, "缺少回调地址")
  192. cfg = dict(cfg, auth="oauth")
  193. if any(f.server_name == name and not f.worker_done for f in _mcp_oauth_flows.values()):
  194. raise McpError(409, f"{name} 的 OAuth 授权正在进行")
  195. home = str(get_hermes_home().expanduser().resolve(strict=False))
  196. flow = DashboardOAuthFlow(flow_id=secrets.token_urlsafe(24), server_name=name, profile=None, hermes_home=home,
  197. redirect_uri=redirect, reconnect_live=False)
  198. _mcp_oauth_flows[flow.flow_id] = flow
  199. threading.Thread(target=_run_dashboard_mcp_oauth, args=(flow, cfg), daemon=True).start()
  200. import asyncio
  201. try:
  202. asyncio.run(flow.wait_for_authorization_url(timeout=30))
  203. except Exception as exc:
  204. flow.mark_error(exception_message(exc))
  205. return flow.snapshot()
  206. def op_auth_status(args: dict) -> dict:
  207. from hermes_cli.web_server_mcp import _mcp_oauth_flows
  208. flow = _mcp_oauth_flows.get(str(args.get("flowId") or ""))
  209. if flow is None:
  210. raise McpError(404, "OAuth 流程不存在或已过期")
  211. snap = flow.snapshot()
  212. snap["tools"] = flow.tools
  213. return snap
  214. def op_auth_cancel(args: dict) -> dict:
  215. from hermes_cli.web_server_mcp import _mcp_oauth_flows
  216. flow = _mcp_oauth_flows.get(str(args.get("flowId") or ""))
  217. if flow is not None:
  218. flow.mark_error("Cancelled by user", cancelled=True)
  219. return {"ok": True}
  220. def op_auth_callback(args: dict) -> dict:
  221. from hermes_cli.web_server_mcp import _mcp_oauth_flows
  222. name, state = str(args.get("name") or ""), args.get("state")
  223. flow = next((f for f in _mcp_oauth_flows.values() if f.server_name == name and f.status == "authorization_required"
  224. and f.expected_state is not None and isinstance(state, str) and secrets.compare_digest(f.expected_state, state)), None)
  225. if flow is None:
  226. raise McpError(404, "OAuth 流程已过期")
  227. try:
  228. flow.deliver_callback(code=args.get("code"), state=state, error=args.get("error"), iss=args.get("iss"))
  229. except ValueError as exc:
  230. raise McpError(409 if "already received" in str(exc) else 400, "回调无效或已使用")
  231. if args.get("error"):
  232. raise McpError(400, "授权失败")
  233. return {"ok": True}