Spaces:
Running
Running
File size: 15,521 Bytes
6fe9090 aa46c09 6fe9090 aa46c09 6fe9090 aa46c09 6fe9090 aa46c09 6fe9090 aa46c09 6fe9090 aa46c09 6fe9090 | 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 | from dataclasses import dataclass
import mcp.types
import pytest
from fastmcp import Client, FastMCP
from fastmcp.client.messages import MessageHandler
from fastmcp.server.context import Context
from fastmcp.tools.tool import Tool
@dataclass
class NotificationRecording:
"""Record of a notification that was received."""
method: str
notification: mcp.types.ServerNotification
class RecordingMessageHandler(MessageHandler):
"""A message handler that records all notifications."""
def __init__(self, name: str | None = None):
super().__init__()
self.notifications: list[NotificationRecording] = []
self.name = name
async def on_notification(self, message: mcp.types.ServerNotification) -> None:
"""Record all notifications."""
self.notifications.append(
NotificationRecording(method=message.root.method, notification=message)
)
def get_notifications(
self, method: str | None = None
) -> list[NotificationRecording]:
"""Get all recorded notifications, optionally filtered by method."""
if method is None:
return self.notifications
return [n for n in self.notifications if n.method == method]
def assert_notification_sent(self, method: str, times: int = 1) -> bool:
"""Assert that a notification was sent a specific number of times."""
notifications = self.get_notifications(method)
actual_times = len(notifications)
assert actual_times == times, (
f"Expected {times} notifications for {method}, "
f"but received {actual_times} notifications"
)
return True
def assert_notification_not_sent(self, method: str) -> bool:
"""Assert that a notification was not sent."""
notifications = self.get_notifications(method)
assert len(notifications) == 0, (
f"Expected no notifications for {method}, but received {len(notifications)}"
)
return True
def reset(self):
"""Clear all recorded notifications."""
self.notifications.clear()
@pytest.fixture
def recording_message_handler():
"""Fixture that provides a recording message handler instance."""
handler = RecordingMessageHandler(name="recording_message_handler")
yield handler
@pytest.fixture
def notification_test_server(recording_message_handler):
"""Create a server for testing notifications."""
mcp = FastMCP(name="NotificationTestServer")
# Create a target tool that can be enabled/disabled
def target_tool() -> str:
"""A tool that can be enabled/disabled."""
return "Target tool executed"
target_tool_obj = Tool.from_function(target_tool)
mcp.add_tool(target_tool_obj)
# Tool to enable the target tool
@mcp.tool
async def enable_target_tool(ctx: Context) -> str:
"""Enable the target tool."""
# Find and enable the target tool
try:
tool = await ctx.fastmcp.get_tool("target_tool")
tool.enable()
return "Target tool enabled"
except Exception:
return "Target tool not found"
# Tool to disable the target tool
@mcp.tool
async def disable_target_tool(ctx: Context) -> str:
"""Disable the target tool."""
# Find and disable the target tool
try:
tool = await ctx.fastmcp.get_tool("target_tool")
tool.disable()
return "Target tool disabled"
except Exception:
return "Target tool not found"
return mcp
class TestToolNotifications:
"""Test tool list changed notifications."""
async def test_tool_enable_sends_notification(
self,
notification_test_server: FastMCP,
recording_message_handler: RecordingMessageHandler,
):
"""Test that enabling a tool sends a tool list changed notification."""
async with Client(
notification_test_server, message_handler=recording_message_handler
) as client:
# Reset any initialization notifications
recording_message_handler.reset()
# Enable the target tool
result = await client.call_tool("enable_target_tool", {})
assert result.data == "Target tool enabled"
# Check that notification was sent
recording_message_handler.assert_notification_sent(
"notifications/tools/list_changed", times=1
)
async def test_tool_disable_sends_notification(
self,
notification_test_server: FastMCP,
recording_message_handler: RecordingMessageHandler,
):
"""Test that disabling a tool sends a tool list changed notification."""
async with Client(
notification_test_server, message_handler=recording_message_handler
) as client:
# Reset any initialization notifications
recording_message_handler.reset()
# Disable the target tool
result = await client.call_tool("disable_target_tool", {})
assert result.data == "Target tool disabled"
# Check that notification was sent
recording_message_handler.assert_notification_sent(
"notifications/tools/list_changed", times=1
)
async def test_multiple_tool_changes_deduplicates_notifications(
self,
notification_test_server: FastMCP,
recording_message_handler: RecordingMessageHandler,
):
"""Test that multiple rapid tool changes result in a single notification."""
async with Client(
notification_test_server, message_handler=recording_message_handler
) as client:
# Reset any initialization notifications
recording_message_handler.reset()
# Enable and disable multiple times in the same context
# This should result in deduplication
await client.call_tool("enable_target_tool", {})
await client.call_tool("disable_target_tool", {})
await client.call_tool("enable_target_tool", {})
# Should have 3 notifications (one per tool call context)
recording_message_handler.assert_notification_sent(
"notifications/tools/list_changed", times=3
)
@pytest.fixture
def resource_notification_test_server(recording_message_handler):
"""Create a server for testing resource notifications."""
mcp = FastMCP(name="ResourceNotificationTestServer")
# Create a target resource that can be enabled/disabled
@mcp.resource("resource://target")
def target_resource() -> str:
"""A resource that can be enabled/disabled."""
return "Target resource content"
# Tool to enable the target resource
@mcp.tool
async def enable_target_resource(ctx: Context) -> str:
"""Enable the target resource."""
try:
resource = await ctx.fastmcp.get_resource("resource://target")
resource.enable()
return "Target resource enabled"
except Exception:
return "Target resource not found"
# Tool to disable the target resource
@mcp.tool
async def disable_target_resource(ctx: Context) -> str:
"""Disable the target resource."""
try:
resource = await ctx.fastmcp.get_resource("resource://target")
resource.disable()
return "Target resource disabled"
except Exception:
return "Target resource not found"
return mcp
class TestResourceNotifications:
"""Test resource list changed notifications."""
async def test_resource_enable_sends_notification(
self,
resource_notification_test_server: FastMCP,
recording_message_handler: RecordingMessageHandler,
):
"""Test that enabling a resource sends a resource list changed notification."""
async with Client(
resource_notification_test_server, message_handler=recording_message_handler
) as client:
# Reset any initialization notifications
recording_message_handler.reset()
# Enable the target resource
result = await client.call_tool("enable_target_resource", {})
assert result.data == "Target resource enabled"
# Check that notification was sent
recording_message_handler.assert_notification_sent(
"notifications/resources/list_changed", times=1
)
async def test_resource_disable_sends_notification(
self,
resource_notification_test_server: FastMCP,
recording_message_handler: RecordingMessageHandler,
):
"""Test that disabling a resource sends a resource list changed notification."""
async with Client(
resource_notification_test_server, message_handler=recording_message_handler
) as client:
# Reset any initialization notifications
recording_message_handler.reset()
# Disable the target resource
result = await client.call_tool("disable_target_resource", {})
assert result.data == "Target resource disabled"
# Check that notification was sent
recording_message_handler.assert_notification_sent(
"notifications/resources/list_changed", times=1
)
@pytest.fixture
def prompt_notification_test_server(recording_message_handler):
"""Create a server for testing prompt notifications."""
mcp = FastMCP(name="PromptNotificationTestServer")
# Create a target prompt that can be enabled/disabled
@mcp.prompt
def target_prompt() -> str:
"""A prompt that can be enabled/disabled."""
return "Target prompt content"
# Tool to enable the target prompt
@mcp.tool
async def enable_target_prompt(ctx: Context) -> str:
"""Enable the target prompt."""
try:
prompt = await ctx.fastmcp.get_prompt("target_prompt")
prompt.enable()
return "Target prompt enabled"
except Exception:
return "Target prompt not found"
# Tool to disable the target prompt
@mcp.tool
async def disable_target_prompt(ctx: Context) -> str:
"""Disable the target prompt."""
try:
prompt = await ctx.fastmcp.get_prompt("target_prompt")
prompt.disable()
return "Target prompt disabled"
except Exception:
return "Target prompt not found"
return mcp
class TestPromptNotifications:
"""Test prompt list changed notifications."""
async def test_prompt_enable_sends_notification(
self,
prompt_notification_test_server: FastMCP,
recording_message_handler: RecordingMessageHandler,
):
"""Test that enabling a prompt sends a prompt list changed notification."""
async with Client(
prompt_notification_test_server, message_handler=recording_message_handler
) as client:
# Reset any initialization notifications
recording_message_handler.reset()
# Enable the target prompt
result = await client.call_tool("enable_target_prompt", {})
assert result.data == "Target prompt enabled"
# Check that notification was sent
recording_message_handler.assert_notification_sent(
"notifications/prompts/list_changed", times=1
)
async def test_prompt_disable_sends_notification(
self,
prompt_notification_test_server: FastMCP,
recording_message_handler: RecordingMessageHandler,
):
"""Test that disabling a prompt sends a prompt list changed notification."""
async with Client(
prompt_notification_test_server, message_handler=recording_message_handler
) as client:
# Reset any initialization notifications
recording_message_handler.reset()
# Disable the target prompt
result = await client.call_tool("disable_target_prompt", {})
assert result.data == "Target prompt disabled"
# Check that notification was sent
recording_message_handler.assert_notification_sent(
"notifications/prompts/list_changed", times=1
)
class TestMessageHandlerGeneral:
"""Test the message handler functionality in general."""
async def test_message_handler_receives_all_notifications(
self,
notification_test_server: FastMCP,
recording_message_handler: RecordingMessageHandler,
):
"""Test that the message handler receives all types of notifications."""
async with Client(
notification_test_server, message_handler=recording_message_handler
) as client:
recording_message_handler.reset()
# Trigger a tool notification
await client.call_tool("enable_target_tool", {})
# Verify the handler received the notification
all_notifications = recording_message_handler.get_notifications()
assert len(all_notifications) == 1
assert all_notifications[0].method == "notifications/tools/list_changed"
async def test_message_handler_notification_filtering(
self,
notification_test_server: FastMCP,
recording_message_handler: RecordingMessageHandler,
):
"""Test that notification filtering works correctly."""
async with Client(
notification_test_server, message_handler=recording_message_handler
) as client:
recording_message_handler.reset()
# Trigger tool notifications
await client.call_tool("enable_target_tool", {})
await client.call_tool("disable_target_tool", {})
# Test filtering
tool_notifications = recording_message_handler.get_notifications(
"notifications/tools/list_changed"
)
assert len(tool_notifications) == 2
# Test non-existent filter
resource_notifications = recording_message_handler.get_notifications(
"notifications/resources/list_changed"
)
assert len(resource_notifications) == 0
async def test_notification_structure(
self,
notification_test_server: FastMCP,
recording_message_handler: RecordingMessageHandler,
):
"""Test that notifications have the correct structure."""
async with Client(
notification_test_server, message_handler=recording_message_handler
) as client:
recording_message_handler.reset()
# Trigger a notification
await client.call_tool("enable_target_tool", {})
# Check notification structure
notifications = recording_message_handler.get_notifications(
"notifications/tools/list_changed"
)
assert len(notifications) == 1
notification = notifications[0]
assert isinstance(notification.notification, mcp.types.ServerNotification)
assert isinstance(
notification.notification.root, mcp.types.ToolListChangedNotification
)
assert (
notification.notification.root.method
== "notifications/tools/list_changed"
)
|