-
Notifications
You must be signed in to change notification settings - Fork 3.7k
Expand file tree
/
Copy pathserver.py
More file actions
1614 lines (1411 loc) · 68.2 KB
/
server.py
File metadata and controls
1614 lines (1411 loc) · 68.2 KB
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
299
300
301
302
303
304
305
306
307
308
309
310
311
312
313
314
315
316
317
318
319
320
321
322
323
324
325
326
327
328
329
330
331
332
333
334
335
336
337
338
339
340
341
342
343
344
345
346
347
348
349
350
351
352
353
354
355
356
357
358
359
360
361
362
363
364
365
366
367
368
369
370
371
372
373
374
375
376
377
378
379
380
381
382
383
384
385
386
387
388
389
390
391
392
393
394
395
396
397
398
399
400
401
402
403
404
405
406
407
408
409
410
411
412
413
414
415
416
417
418
419
420
421
422
423
424
425
426
427
428
429
430
431
432
433
434
435
436
437
438
439
440
441
442
443
444
445
446
447
448
449
450
451
452
453
454
455
456
457
458
459
460
461
462
463
464
465
466
467
468
469
470
471
472
473
474
475
476
477
478
479
480
481
482
483
484
485
486
487
488
489
490
491
492
493
494
495
496
497
498
499
500
501
502
503
504
505
506
507
508
509
510
511
512
513
514
515
516
517
518
519
520
521
522
523
524
525
526
527
528
529
530
531
532
533
534
535
536
537
538
539
540
541
542
543
544
545
546
547
548
549
550
551
552
553
554
555
556
557
558
559
560
561
562
563
564
565
566
567
568
569
570
571
572
573
574
575
576
577
578
579
580
581
582
583
584
585
586
587
588
589
590
591
592
593
594
595
596
597
598
599
600
601
602
603
604
605
606
607
608
609
610
611
612
613
614
615
616
617
618
619
620
621
622
623
624
625
626
627
628
629
630
631
632
633
634
635
636
637
638
639
640
641
642
643
644
645
646
647
648
649
650
651
652
653
654
655
656
657
658
659
660
661
662
663
664
665
666
667
668
669
670
671
672
673
674
675
676
677
678
679
680
681
682
683
684
685
686
687
688
689
690
691
692
693
694
695
696
697
698
699
700
701
702
703
704
705
706
707
708
709
710
711
712
713
714
715
716
717
718
719
720
721
722
723
724
725
726
727
728
729
730
731
732
733
734
735
736
737
738
739
740
741
742
743
744
745
746
747
748
749
750
751
752
753
754
755
756
757
758
759
760
761
762
763
764
765
766
767
768
769
770
771
772
773
774
775
776
777
778
779
780
781
782
783
784
785
786
787
788
789
790
791
792
793
794
795
796
797
798
799
800
801
802
803
804
805
806
807
808
809
810
811
812
813
814
815
816
817
818
819
820
821
822
823
824
825
826
827
828
829
830
831
832
833
834
835
836
837
838
839
840
841
842
843
844
845
846
847
848
849
850
851
852
853
854
855
856
857
858
859
860
861
862
863
864
865
866
867
868
869
870
871
872
873
874
875
876
877
878
879
880
881
882
883
884
885
886
887
888
889
890
891
892
893
894
895
896
897
898
899
900
901
902
903
904
905
906
907
908
909
910
911
912
913
914
915
916
917
918
919
920
921
922
923
924
925
926
927
928
929
930
931
932
933
934
935
936
937
938
939
940
941
942
943
944
945
946
947
948
949
950
951
952
953
954
955
956
957
958
959
960
961
962
963
964
965
966
967
968
969
970
971
972
973
974
975
976
977
978
979
980
981
982
983
984
985
986
987
988
989
990
991
992
993
994
995
996
997
998
999
1000
from __future__ import annotations
import abc
import asyncio
import inspect
import sys
from collections.abc import AsyncGenerator, Awaitable
from contextlib import AbstractAsyncContextManager, AsyncExitStack, asynccontextmanager
from datetime import timedelta
from pathlib import Path
from typing import TYPE_CHECKING, Any, Callable, Literal, TypeVar, Union, cast
import anyio
import httpx
if sys.version_info < (3, 11):
from exceptiongroup import BaseExceptionGroup # pyright: ignore[reportMissingImports]
from anyio import ClosedResourceError
from anyio.streams.memory import MemoryObjectReceiveStream, MemoryObjectSendStream
from mcp import ClientSession, StdioServerParameters, Tool as MCPTool, stdio_client
from mcp.client.session import MessageHandlerFnT
from mcp.client.sse import sse_client
from mcp.client.streamable_http import (
GetSessionIdCallback,
StreamableHTTPTransport,
streamablehttp_client,
)
from mcp.shared.exceptions import McpError
from mcp.shared.message import SessionMessage
from mcp.types import (
CallToolResult,
GetPromptResult,
InitializeResult,
ListPromptsResult,
ListResourcesResult,
ListResourceTemplatesResult,
ReadResourceResult,
)
from typing_extensions import NotRequired, TypedDict
from ..exceptions import UserError
from ..logger import logger
from ..run_context import RunContextWrapper
from ..tool import ToolErrorFunction
from ..util._types import MaybeAwaitable
from .util import (
HttpClientFactory,
MCPToolMetaResolver,
ToolFilter,
ToolFilterContext,
ToolFilterStatic,
)
class RequireApprovalToolList(TypedDict, total=False):
tool_names: list[str]
class RequireApprovalObject(TypedDict, total=False):
always: RequireApprovalToolList
never: RequireApprovalToolList
RequireApprovalPolicy = Literal["always", "never"]
RequireApprovalMapping = dict[str, RequireApprovalPolicy]
if TYPE_CHECKING:
RequireApprovalSetting = (
RequireApprovalPolicy | RequireApprovalObject | RequireApprovalMapping | bool | None
)
else:
RequireApprovalSetting = Union[ # noqa: UP007
RequireApprovalPolicy, RequireApprovalObject, RequireApprovalMapping, bool, None
]
T = TypeVar("T")
def _create_default_streamable_http_client(
headers: dict[str, str] | None = None,
timeout: httpx.Timeout | None = None,
auth: httpx.Auth | None = None,
) -> httpx.AsyncClient:
kwargs: dict[str, Any] = {"follow_redirects": True}
if timeout is not None:
kwargs["timeout"] = timeout
if headers is not None:
kwargs["headers"] = headers
if auth is not None:
kwargs["auth"] = auth
return httpx.AsyncClient(**kwargs)
class _InitializedNotificationTolerantStreamableHTTPTransport(StreamableHTTPTransport):
async def _handle_post_request(self, ctx: Any) -> None:
message = ctx.session_message.message
if not self._is_initialized_notification(message):
await super()._handle_post_request(ctx)
return
try:
await super()._handle_post_request(ctx)
except httpx.HTTPError:
logger.warning(
"Ignoring initialized notification HTTP failure",
exc_info=True,
)
return
@asynccontextmanager
async def _streamablehttp_client_with_transport(
url: str,
*,
headers: dict[str, str] | None = None,
timeout: float | timedelta = 30,
sse_read_timeout: float | timedelta = 60 * 5,
terminate_on_close: bool = True,
httpx_client_factory: HttpClientFactory = _create_default_streamable_http_client,
auth: httpx.Auth | None = None,
transport_factory: Callable[[str], StreamableHTTPTransport] = StreamableHTTPTransport,
) -> AsyncGenerator[MCPStreamTransport, None]:
timeout_seconds = timeout.total_seconds() if isinstance(timeout, timedelta) else timeout
sse_read_timeout_seconds = (
sse_read_timeout.total_seconds()
if isinstance(sse_read_timeout, timedelta)
else sse_read_timeout
)
client = httpx_client_factory(
headers=headers,
timeout=httpx.Timeout(timeout_seconds, read=sse_read_timeout_seconds),
auth=auth,
)
transport = transport_factory(url)
read_stream_writer, read_stream = anyio.create_memory_object_stream[SessionMessage | Exception](
0
)
write_stream, write_stream_reader = anyio.create_memory_object_stream[SessionMessage](0)
async with client:
async with anyio.create_task_group() as tg:
try:
logger.debug(f"Connecting to StreamableHTTP endpoint: {url}")
def start_get_stream() -> None:
tg.start_soon(transport.handle_get_stream, client, read_stream_writer)
tg.start_soon(
transport.post_writer,
client,
write_stream_reader,
read_stream_writer,
write_stream,
start_get_stream,
tg,
)
try:
yield (
read_stream,
write_stream,
transport.get_session_id,
)
finally:
if transport.session_id and terminate_on_close:
await transport.terminate_session(client)
tg.cancel_scope.cancel()
finally:
await read_stream_writer.aclose()
await write_stream.aclose()
class _SharedSessionRequestNeedsIsolation(Exception):
"""Raised when a shared-session request should be retried on an isolated session."""
class _IsolatedSessionRetryFailed(Exception):
"""Raised when an isolated-session retry fails after consuming retry budget."""
class _UnsetType:
pass
_UNSET = _UnsetType()
if TYPE_CHECKING:
from ..agent import AgentBase
MCPStreamTransport = (
tuple[
MemoryObjectReceiveStream[SessionMessage | Exception],
MemoryObjectSendStream[SessionMessage],
]
| tuple[
MemoryObjectReceiveStream[SessionMessage | Exception],
MemoryObjectSendStream[SessionMessage],
GetSessionIdCallback | None,
]
)
class MCPServer(abc.ABC):
"""Base class for Model Context Protocol servers."""
def __init__(
self,
use_structured_content: bool = False,
require_approval: RequireApprovalSetting = None,
failure_error_function: ToolErrorFunction | None | _UnsetType = _UNSET,
tool_meta_resolver: MCPToolMetaResolver | None = None,
):
"""
Args:
use_structured_content: Whether to use `tool_result.structured_content` when calling an
MCP tool.Defaults to False for backwards compatibility - most MCP servers still
include the structured content in the `tool_result.content`, and using it by
default will cause duplicate content. You can set this to True if you know the
server will not duplicate the structured content in the `tool_result.content`.
require_approval: Approval policy for tools on this server. Accepts "always"/"never",
a dict of tool names to those values, a boolean, or an object with always/never
tool lists (mirroring TS requireApproval). Normalized into a needs_approval policy.
failure_error_function: Optional function used to convert MCP tool failures into
a model-visible error message. If explicitly set to None, tool errors will be
raised instead of converted. If left unset, the agent-level configuration (or
SDK default) will be used.
tool_meta_resolver: Optional callable that produces MCP request metadata (`_meta`) for
tool calls. It is invoked by the Agents SDK before calling `call_tool`.
"""
self.use_structured_content = use_structured_content
self._needs_approval_policy = self._normalize_needs_approval(
require_approval=require_approval
)
self._failure_error_function = failure_error_function
self.tool_meta_resolver = tool_meta_resolver
@abc.abstractmethod
async def connect(self):
"""Connect to the server. For example, this might mean spawning a subprocess or
opening a network connection. The server is expected to remain connected until
`cleanup()` is called.
"""
pass
@property
@abc.abstractmethod
def name(self) -> str:
"""A readable name for the server."""
pass
@abc.abstractmethod
async def cleanup(self):
"""Cleanup the server. For example, this might mean closing a subprocess or
closing a network connection.
"""
pass
@abc.abstractmethod
async def list_tools(
self,
run_context: RunContextWrapper[Any] | None = None,
agent: AgentBase | None = None,
) -> list[MCPTool]:
"""List the tools available on the server."""
pass
@abc.abstractmethod
async def call_tool(
self,
tool_name: str,
arguments: dict[str, Any] | None,
meta: dict[str, Any] | None = None,
) -> CallToolResult:
"""Invoke a tool on the server."""
pass
@property
def cached_tools(self) -> list[MCPTool] | None:
"""Return the most recently fetched tools list, if available.
Implementations may return `None` when tools have not been fetched yet or caching is
disabled.
"""
return None
@abc.abstractmethod
async def list_prompts(
self,
) -> ListPromptsResult:
"""List the prompts available on the server."""
pass
@abc.abstractmethod
async def get_prompt(
self, name: str, arguments: dict[str, Any] | None = None
) -> GetPromptResult:
"""Get a specific prompt from the server."""
pass
async def list_resources(self, cursor: str | None = None) -> ListResourcesResult:
"""List the resources available on the server.
Args:
cursor: An opaque pagination cursor returned in a previous
:class:`~mcp.types.ListResourcesResult` as ``nextCursor``. Pass it
here to fetch the next page of results. ``None`` fetches the first
page.
Returns a :class:`~mcp.types.ListResourcesResult`. When the result contains
a ``nextCursor`` field, call this method again with that cursor to retrieve
the next page. Subclasses that do not support resources may leave this
unimplemented; it will raise :exc:`NotImplementedError` at call time.
"""
raise NotImplementedError(
f"MCP server '{self.name}' does not support list_resources. "
"Override this method in your server implementation."
)
async def list_resource_templates(
self, cursor: str | None = None
) -> ListResourceTemplatesResult:
"""List the resource templates available on the server.
Args:
cursor: An opaque pagination cursor returned in a previous
:class:`~mcp.types.ListResourceTemplatesResult` as ``nextCursor``.
Pass it here to fetch the next page of results. ``None`` fetches
the first page.
Returns a :class:`~mcp.types.ListResourceTemplatesResult`. When the result
contains a ``nextCursor`` field, call this method again with that cursor to
retrieve the next page. Subclasses that do not support resource templates
may leave this unimplemented; it will raise :exc:`NotImplementedError` at
call time.
"""
raise NotImplementedError(
f"MCP server '{self.name}' does not support list_resource_templates. "
"Override this method in your server implementation."
)
async def read_resource(self, uri: str) -> ReadResourceResult:
"""Read the contents of a specific resource by URI.
Args:
uri: The URI of the resource to read. See :class:`~pydantic.networks.AnyUrl`
for the supported URI formats.
Returns a :class:`~mcp.types.ReadResourceResult`. Subclasses that do not
support resources may leave this unimplemented; it will raise
:exc:`NotImplementedError` at call time.
"""
raise NotImplementedError(
f"MCP server '{self.name}' does not support read_resource. "
"Override this method in your server implementation."
)
@staticmethod
def _normalize_needs_approval(
*,
require_approval: RequireApprovalSetting,
) -> (
bool
| dict[str, bool]
| Callable[[RunContextWrapper[Any], AgentBase, MCPTool], MaybeAwaitable[bool]]
):
"""Normalize approval inputs to booleans or a name->bool map."""
if require_approval is None:
return False
def _to_bool(value: str) -> bool:
return value == "always"
def _is_tool_list_schema(value: object) -> bool:
if not isinstance(value, dict):
return False
for key in ("always", "never"):
if key not in value:
continue
entry = value.get(key)
if isinstance(entry, dict) and "tool_names" in entry:
return True
return False
if isinstance(require_approval, dict) and _is_tool_list_schema(require_approval):
always_entry: RequireApprovalToolList | Any = require_approval.get("always", {})
never_entry: RequireApprovalToolList | Any = require_approval.get("never", {})
always_names = (
always_entry.get("tool_names", []) if isinstance(always_entry, dict) else []
)
never_names = never_entry.get("tool_names", []) if isinstance(never_entry, dict) else []
tool_list_mapping: dict[str, bool] = {}
for name in always_names:
tool_list_mapping[str(name)] = True
for name in never_names:
tool_list_mapping[str(name)] = False
return tool_list_mapping
if isinstance(require_approval, dict):
tool_mapping: dict[str, bool] = {}
for name, value in require_approval.items():
if isinstance(value, bool):
tool_mapping[str(name)] = value
elif isinstance(value, str) and value in ("always", "never"):
tool_mapping[str(name)] = _to_bool(value)
return tool_mapping
if isinstance(require_approval, bool):
return require_approval
return _to_bool(require_approval)
def _get_needs_approval_for_tool(
self,
tool: MCPTool,
agent: AgentBase | None,
) -> bool | Callable[[RunContextWrapper[Any], dict[str, Any], str], Awaitable[bool]]:
"""Return a FunctionTool.needs_approval value for a given MCP tool."""
policy = self._needs_approval_policy
if callable(policy):
if agent is None:
return True
async def _needs_approval(
run_context: RunContextWrapper[Any], _args: dict[str, Any], _call_id: str
) -> bool:
result = policy(run_context, agent, tool)
if inspect.isawaitable(result):
result = await result
return bool(result)
return _needs_approval
if isinstance(policy, dict):
return bool(policy.get(tool.name, False))
return bool(policy)
def _get_failure_error_function(
self, agent_failure_error_function: ToolErrorFunction | None
) -> ToolErrorFunction | None:
"""Return the effective error handler for MCP tool failures."""
if self._failure_error_function is _UNSET:
return agent_failure_error_function
return cast(ToolErrorFunction | None, self._failure_error_function)
class _MCPServerWithClientSession(MCPServer, abc.ABC):
"""Base class for MCP servers that use a `ClientSession` to communicate with the server."""
@property
def cached_tools(self) -> list[MCPTool] | None:
return self._tools_list
def __init__(
self,
cache_tools_list: bool,
client_session_timeout_seconds: float | None,
tool_filter: ToolFilter = None,
use_structured_content: bool = False,
max_retry_attempts: int = 0,
retry_backoff_seconds_base: float = 1.0,
message_handler: MessageHandlerFnT | None = None,
require_approval: RequireApprovalSetting = None,
failure_error_function: ToolErrorFunction | None | _UnsetType = _UNSET,
tool_meta_resolver: MCPToolMetaResolver | None = None,
):
"""
Args:
cache_tools_list: Whether to cache the tools list. If `True`, the tools list will be
cached and only fetched from the server once. If `False`, the tools list will be
fetched from the server on each call to `list_tools()`. The cache can be invalidated
by calling `invalidate_tools_cache()`. You should set this to `True` if you know the
server will not change its tools list, because it can drastically improve latency
(by avoiding a round-trip to the server every time).
client_session_timeout_seconds: the read timeout passed to the MCP ClientSession.
tool_filter: The tool filter to use for filtering tools.
use_structured_content: Whether to use `tool_result.structured_content` when calling an
MCP tool. Defaults to False for backwards compatibility - most MCP servers still
include the structured content in the `tool_result.content`, and using it by
default will cause duplicate content. You can set this to True if you know the
server will not duplicate the structured content in the `tool_result.content`.
max_retry_attempts: Number of times to retry failed list_tools/call_tool calls.
Defaults to no retries.
retry_backoff_seconds_base: The base delay, in seconds, used for exponential
backoff between retries.
message_handler: Optional handler invoked for session messages as delivered by the
ClientSession.
require_approval: Approval policy for tools on this server. Accepts "always"/"never",
a dict of tool names to those values, a boolean, or an object with always/never
tool lists.
failure_error_function: Optional function used to convert MCP tool failures into
a model-visible error message. If explicitly set to None, tool errors will be
raised instead of converted. If left unset, the agent-level configuration (or
SDK default) will be used.
tool_meta_resolver: Optional callable that produces MCP request metadata (`_meta`) for
tool calls. It is invoked by the Agents SDK before calling `call_tool`.
"""
super().__init__(
use_structured_content=use_structured_content,
require_approval=require_approval,
failure_error_function=failure_error_function,
tool_meta_resolver=tool_meta_resolver,
)
self.session: ClientSession | None = None
self.exit_stack: AsyncExitStack = AsyncExitStack()
self._cleanup_lock: asyncio.Lock = asyncio.Lock()
self._request_lock: asyncio.Lock = asyncio.Lock()
self.cache_tools_list = cache_tools_list
self.server_initialize_result: InitializeResult | None = None
self.client_session_timeout_seconds = client_session_timeout_seconds
self.max_retry_attempts = max_retry_attempts
self.retry_backoff_seconds_base = retry_backoff_seconds_base
self.message_handler = message_handler
# The cache is always dirty at startup, so that we fetch tools at least once
self._cache_dirty = True
self._tools_list: list[MCPTool] | None = None
self.tool_filter = tool_filter
self._serialize_session_requests = False
self._get_session_id: GetSessionIdCallback | None = None
async def _maybe_serialize_request(self, func: Callable[[], Awaitable[T]]) -> T:
if not self._serialize_session_requests:
return await func()
async with self._request_lock:
return await func()
async def _apply_tool_filter(
self,
tools: list[MCPTool],
run_context: RunContextWrapper[Any] | None = None,
agent: AgentBase | None = None,
) -> list[MCPTool]:
"""Apply the tool filter to the list of tools."""
if self.tool_filter is None:
return tools
# Handle static tool filter
if isinstance(self.tool_filter, dict):
return self._apply_static_tool_filter(tools, self.tool_filter)
# Handle callable tool filter (dynamic filter)
else:
if run_context is None or agent is None:
raise UserError("run_context and agent are required for dynamic tool filtering")
return await self._apply_dynamic_tool_filter(tools, run_context, agent)
def _apply_static_tool_filter(
self, tools: list[MCPTool], static_filter: ToolFilterStatic
) -> list[MCPTool]:
"""Apply static tool filtering based on allowlist and blocklist."""
filtered_tools = tools
# Apply allowed_tool_names filter (whitelist)
if "allowed_tool_names" in static_filter:
allowed_names = static_filter["allowed_tool_names"]
filtered_tools = [t for t in filtered_tools if t.name in allowed_names]
# Apply blocked_tool_names filter (blacklist)
if "blocked_tool_names" in static_filter:
blocked_names = static_filter["blocked_tool_names"]
filtered_tools = [t for t in filtered_tools if t.name not in blocked_names]
return filtered_tools
async def _apply_dynamic_tool_filter(
self,
tools: list[MCPTool],
run_context: RunContextWrapper[Any],
agent: AgentBase,
) -> list[MCPTool]:
"""Apply dynamic tool filtering using a callable filter function."""
# Ensure we have a callable filter
if not callable(self.tool_filter):
raise ValueError("Tool filter must be callable for dynamic filtering")
tool_filter_func = self.tool_filter
# Create filter context
filter_context = ToolFilterContext(
run_context=run_context,
agent=agent,
server_name=self.name,
)
filtered_tools = []
for tool in tools:
try:
# Call the filter function with context
result = tool_filter_func(filter_context, tool)
if inspect.isawaitable(result):
should_include = await result
else:
should_include = result
if should_include:
filtered_tools.append(tool)
except Exception as e:
logger.error(
f"Error applying tool filter to tool '{tool.name}' on server '{self.name}': {e}"
)
# On error, exclude the tool for safety
continue
return filtered_tools
@abc.abstractmethod
def create_streams(
self,
) -> AbstractAsyncContextManager[MCPStreamTransport]:
"""Create the streams for the server."""
pass
async def __aenter__(self):
await self.connect()
return self
async def __aexit__(self, exc_type, exc_value, traceback):
await self.cleanup()
def invalidate_tools_cache(self):
"""Invalidate the tools cache."""
self._cache_dirty = True
def _extract_http_error_from_exception(self, e: BaseException) -> Exception | None:
"""Extract HTTP error from exception or ExceptionGroup."""
if isinstance(e, (httpx.HTTPStatusError, httpx.ConnectError, httpx.TimeoutException)):
return e
# Check if it's an ExceptionGroup containing HTTP errors
if isinstance(e, BaseExceptionGroup):
for exc in e.exceptions:
if isinstance(
exc, (httpx.HTTPStatusError, httpx.ConnectError, httpx.TimeoutException)
):
return exc
return None
def _raise_user_error_for_http_error(self, http_error: Exception) -> None:
"""Raise appropriate UserError for HTTP error."""
error_message = f"Failed to connect to MCP server '{self.name}': "
if isinstance(http_error, httpx.HTTPStatusError):
error_message += f"HTTP error {http_error.response.status_code} ({http_error.response.reason_phrase})" # noqa: E501
elif isinstance(http_error, httpx.ConnectError):
error_message += "Could not reach the server."
elif isinstance(http_error, httpx.TimeoutException):
error_message += "Connection timeout."
raise UserError(error_message) from http_error
async def _run_with_retries(self, func: Callable[[], Awaitable[T]]) -> T:
attempts = 0
while True:
try:
return await func()
except Exception:
attempts += 1
if self.max_retry_attempts != -1 and attempts > self.max_retry_attempts:
raise
backoff = self.retry_backoff_seconds_base * (2 ** (attempts - 1))
await asyncio.sleep(backoff)
async def connect(self):
"""Connect to the server."""
connection_succeeded = False
try:
transport = await self.exit_stack.enter_async_context(self.create_streams())
# streamablehttp_client returns (read, write, get_session_id)
# sse_client returns (read, write)
read, write, *rest = transport
# Capture the session-id callback when present (streamablehttp_client only).
self._get_session_id = rest[0] if rest and callable(rest[0]) else None
session = await self.exit_stack.enter_async_context(
ClientSession(
read,
write,
timedelta(seconds=self.client_session_timeout_seconds)
if self.client_session_timeout_seconds
else None,
message_handler=self.message_handler,
)
)
server_result = await session.initialize()
self.server_initialize_result = server_result
self.session = session
connection_succeeded = True
except Exception as e:
# Try to extract HTTP error from exception or ExceptionGroup
http_error = self._extract_http_error_from_exception(e)
if http_error:
self._raise_user_error_for_http_error(http_error)
# For CancelledError, preserve cancellation semantics - don't wrap it.
# If it's masking an HTTP error, cleanup() will extract and raise UserError.
if isinstance(e, asyncio.CancelledError):
raise
# For HTTP-related errors, wrap them
if isinstance(e, (httpx.HTTPStatusError, httpx.ConnectError, httpx.TimeoutException)):
self._raise_user_error_for_http_error(e)
# For other errors, re-raise as-is (don't wrap non-HTTP errors)
raise
finally:
# Always attempt cleanup on error, but suppress cleanup errors that mask the original
if not connection_succeeded:
try:
await self.cleanup()
except UserError:
# Re-raise UserError from cleanup (contains the real HTTP error)
raise
except Exception as cleanup_error:
# Suppress RuntimeError about cancel scopes during cleanup - this is a known
# issue with the MCP library's async generator cleanup and shouldn't mask the
# original error
if isinstance(cleanup_error, RuntimeError) and "cancel scope" in str(
cleanup_error
):
logger.debug(
f"Ignoring cancel scope error during cleanup of MCP server "
f"'{self.name}': {cleanup_error}"
)
else:
# Log other cleanup errors but don't raise - original error is more
# important
logger.warning(
f"Error during cleanup of MCP server '{self.name}': {cleanup_error}"
)
async def list_tools(
self,
run_context: RunContextWrapper[Any] | None = None,
agent: AgentBase | None = None,
) -> list[MCPTool]:
"""List the tools available on the server."""
if not self.session:
raise UserError("Server not initialized. Make sure you call `connect()` first.")
session = self.session
assert session is not None
try:
# Return from cache if caching is enabled, we have tools, and the cache is not dirty
if self.cache_tools_list and not self._cache_dirty and self._tools_list:
tools = self._tools_list
else:
# Fetch the tools from the server
result = await self._run_with_retries(
lambda: self._maybe_serialize_request(lambda: session.list_tools())
)
self._tools_list = result.tools
self._cache_dirty = False
tools = self._tools_list
# Filter tools based on tool_filter
filtered_tools = tools
if self.tool_filter is not None:
filtered_tools = await self._apply_tool_filter(filtered_tools, run_context, agent)
return filtered_tools
except httpx.HTTPStatusError as e:
status_code = e.response.status_code
raise UserError(
f"Failed to list tools from MCP server '{self.name}': HTTP error {status_code}"
) from e
except httpx.ConnectError as e:
raise UserError(
f"Failed to list tools from MCP server '{self.name}': Connection lost. "
f"The server may have disconnected."
) from e
async def call_tool(
self,
tool_name: str,
arguments: dict[str, Any] | None,
meta: dict[str, Any] | None = None,
) -> CallToolResult:
"""Invoke a tool on the server."""
if not self.session:
raise UserError("Server not initialized. Make sure you call `connect()` first.")
session = self.session
assert session is not None
try:
self._validate_required_parameters(tool_name=tool_name, arguments=arguments)
if meta is None:
return await self._run_with_retries(
lambda: self._maybe_serialize_request(
lambda: session.call_tool(tool_name, arguments)
)
)
return await self._run_with_retries(
lambda: self._maybe_serialize_request(
lambda: session.call_tool(tool_name, arguments, meta=meta)
)
)
except httpx.HTTPStatusError as e:
status_code = e.response.status_code
raise UserError(
f"Failed to call tool '{tool_name}' on MCP server '{self.name}': "
f"HTTP error {status_code}"
) from e
except httpx.ConnectError as e:
raise UserError(
f"Failed to call tool '{tool_name}' on MCP server '{self.name}': Connection lost. "
f"The server may have disconnected."
) from e
def _validate_required_parameters(
self, tool_name: str, arguments: dict[str, Any] | None
) -> None:
"""Validate required tool parameters from cached MCP tool schemas before invocation."""
if self._tools_list is None:
return
tool = next((item for item in self._tools_list if item.name == tool_name), None)
if tool is None or not isinstance(tool.inputSchema, dict):
return
raw_required = tool.inputSchema.get("required")
if not isinstance(raw_required, list) or not raw_required:
return
if arguments is None:
arguments_to_validate: dict[str, Any] = {}
elif isinstance(arguments, dict):
arguments_to_validate = arguments
else:
raise UserError(
f"Failed to call tool '{tool_name}' on MCP server '{self.name}': "
"arguments must be an object."
)
required_names = [name for name in raw_required if isinstance(name, str)]
missing = [name for name in required_names if name not in arguments_to_validate]
if missing:
missing_text = ", ".join(sorted(missing))
raise UserError(
f"Failed to call tool '{tool_name}' on MCP server '{self.name}': "
f"missing required parameters: {missing_text}"
)
async def list_prompts(
self,
) -> ListPromptsResult:
"""List the prompts available on the server."""
if not self.session:
raise UserError("Server not initialized. Make sure you call `connect()` first.")
session = self.session
assert session is not None
return await self._maybe_serialize_request(lambda: session.list_prompts())
async def get_prompt(
self, name: str, arguments: dict[str, Any] | None = None
) -> GetPromptResult:
"""Get a specific prompt from the server."""
if not self.session:
raise UserError("Server not initialized. Make sure you call `connect()` first.")
session = self.session
assert session is not None
return await self._maybe_serialize_request(lambda: session.get_prompt(name, arguments))
async def list_resources(self, cursor: str | None = None) -> ListResourcesResult:
"""List the resources available on the server."""
if not self.session:
raise UserError("Server not initialized. Make sure you call `connect()` first.")
session = self.session
assert session is not None
return await self._maybe_serialize_request(lambda: session.list_resources(cursor))
async def list_resource_templates(
self, cursor: str | None = None
) -> ListResourceTemplatesResult:
"""List the resource templates available on the server."""
if not self.session:
raise UserError("Server not initialized. Make sure you call `connect()` first.")
session = self.session
assert session is not None
return await self._maybe_serialize_request(lambda: session.list_resource_templates(cursor))
async def read_resource(self, uri: str) -> ReadResourceResult:
"""Read the contents of a specific resource by URI.
Args:
uri: The URI of the resource to read. See :class:`~pydantic.networks.AnyUrl`
for the supported URI formats.
"""
if not self.session:
raise UserError("Server not initialized. Make sure you call `connect()` first.")
session = self.session
assert session is not None
from pydantic import AnyUrl
return await self._maybe_serialize_request(lambda: session.read_resource(AnyUrl(uri)))
async def cleanup(self):
"""Cleanup the server."""
async with self._cleanup_lock:
# Only raise HTTP errors if we're cleaning up after a failed connection.
# During normal teardown (via __aexit__), log but don't raise to avoid
# masking the original exception.
is_failed_connection_cleanup = self.session is None
try:
# Signal the subprocess to shut down gracefully before the exit stack
# unwinds. The exit stack tears down contexts in LIFO order: the
# ClientSession exits first (cancelling its internal task group), then
# the transport (stdio_client / sse_client) exits. Because the
# ClientSession cancellation kills the reader/writer tasks inside the
# transport, the transport's ``finally`` block — which tries to close
# stdin and wait for the process — may never execute cleanly. By
# closing the session's write stream ahead of time we deliver an EOF to
# the subprocess's stdin, giving it a chance to flush resources (e.g.
# multiprocessing semaphores) and exit on its own before we cancel the
# task groups.
if self.session is not None:
try:
await self.session._write_stream.aclose()
except Exception:
pass # Best-effort; the stream may already be closed.
await self.exit_stack.aclose()
except asyncio.CancelledError as e:
logger.debug(f"Cleanup cancelled for MCP server '{self.name}': {e}")
raise
except BaseExceptionGroup as eg:
# Extract HTTP errors from ExceptionGroup raised during cleanup
# This happens when background tasks fail (e.g., HTTP errors)
http_error = None
connect_error = None
timeout_error = None
error_message = f"Failed to connect to MCP server '{self.name}': "
for exc in eg.exceptions:
if isinstance(exc, httpx.HTTPStatusError):
http_error = exc
elif isinstance(exc, httpx.ConnectError):
connect_error = exc
elif isinstance(exc, httpx.TimeoutException):
timeout_error = exc
# Only raise HTTP errors if we're cleaning up after a failed connection.
# During normal teardown, log them instead.
if http_error:
if is_failed_connection_cleanup:
error_message += f"HTTP error {http_error.response.status_code} ({http_error.response.reason_phrase})" # noqa: E501
raise UserError(error_message) from http_error
else:
# Normal teardown - log but don't raise
logger.warning(
f"HTTP error during cleanup of MCP server '{self.name}': {http_error}"
)
elif connect_error:
if is_failed_connection_cleanup:
error_message += "Could not reach the server."
raise UserError(error_message) from connect_error
else:
logger.warning(
f"Connection error during cleanup of MCP server '{self.name}': {connect_error}" # noqa: E501
)
elif timeout_error:
if is_failed_connection_cleanup:
error_message += "Connection timeout."
raise UserError(error_message) from timeout_error
else:
logger.warning(
f"Timeout error during cleanup of MCP server '{self.name}': {timeout_error}" # noqa: E501
)
else:
# No HTTP error found, suppress RuntimeError about cancel scopes
has_cancel_scope_error = any(
isinstance(exc, RuntimeError) and "cancel scope" in str(exc)
for exc in eg.exceptions
)
if has_cancel_scope_error:
logger.debug(f"Ignoring cancel scope error during cleanup: {eg}")
else:
logger.error(f"Error cleaning up server: {eg}")
except Exception as e:
# Suppress RuntimeError about cancel scopes - this is a known issue with the MCP
# library when background tasks fail during async generator cleanup
if isinstance(e, RuntimeError) and "cancel scope" in str(e):
logger.debug(f"Ignoring cancel scope error during cleanup: {e}")
else:
logger.error(f"Error cleaning up server: {e}")
finally:
self.session = None
self._get_session_id = None