2025-12-19 09:54:03 -08:00
|
|
|
from typing import Any, Literal
|
2025-03-19 09:40:08 +00:00
|
|
|
|
|
|
|
|
import pytest
|
|
|
|
|
|
2026-02-03 17:42:29 +01:00
|
|
|
from mcp import Client, types
|
2026-03-04 13:23:02 +00:00
|
|
|
from mcp.server.mcpserver import Context, MCPServer
|
2025-03-24 14:14:14 +00:00
|
|
|
from mcp.shared.session import RequestResponder
|
2025-03-19 09:40:08 +00:00
|
|
|
from mcp.types import (
|
|
|
|
|
LoggingMessageNotificationParams,
|
|
|
|
|
TextContent,
|
|
|
|
|
)
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
class LoggingCollector:
|
|
|
|
|
def __init__(self):
|
2025-03-20 09:13:08 +00:00
|
|
|
self.log_messages: list[LoggingMessageNotificationParams] = []
|
2025-03-19 09:40:08 +00:00
|
|
|
|
|
|
|
|
async def __call__(self, params: LoggingMessageNotificationParams) -> None:
|
|
|
|
|
self.log_messages.append(params)
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
@pytest.mark.anyio
|
|
|
|
|
async def test_logging_callback():
|
2026-01-25 14:45:52 +01:00
|
|
|
server = MCPServer("test")
|
2025-03-19 09:40:08 +00:00
|
|
|
logging_collector = LoggingCollector()
|
|
|
|
|
|
|
|
|
|
# Create a simple test tool
|
|
|
|
|
@server.tool("test_tool")
|
|
|
|
|
async def test_tool() -> bool:
|
|
|
|
|
# The actual tool is very simple and just returns True
|
|
|
|
|
return True
|
|
|
|
|
|
|
|
|
|
# Create a function that can send a log notification
|
|
|
|
|
@server.tool("test_tool_with_log")
|
|
|
|
|
async def test_tool_with_log(
|
2026-03-04 13:23:02 +00:00
|
|
|
message: str, level: Literal["debug", "info", "warning", "error"], logger: str, ctx: Context
|
2025-03-19 09:40:08 +00:00
|
|
|
) -> bool:
|
|
|
|
|
"""Send a log notification to the client."""
|
2026-03-04 13:23:02 +00:00
|
|
|
await ctx.log(level=level, message=message, logger_name=logger)
|
2025-03-19 09:40:08 +00:00
|
|
|
return True
|
|
|
|
|
|
2025-12-19 09:54:03 -08:00
|
|
|
@server.tool("test_tool_with_log_extra")
|
|
|
|
|
async def test_tool_with_log_extra(
|
|
|
|
|
message: str,
|
|
|
|
|
level: Literal["debug", "info", "warning", "error"],
|
|
|
|
|
logger: str,
|
|
|
|
|
extra_string: str,
|
|
|
|
|
extra_dict: dict[str, Any],
|
2026-03-04 13:23:02 +00:00
|
|
|
ctx: Context,
|
2025-12-19 09:54:03 -08:00
|
|
|
) -> bool:
|
|
|
|
|
"""Send a log notification to the client with extra fields."""
|
2026-03-04 13:23:02 +00:00
|
|
|
await ctx.log(
|
2025-12-19 09:54:03 -08:00
|
|
|
level=level,
|
|
|
|
|
message=message,
|
|
|
|
|
logger_name=logger,
|
|
|
|
|
extra={"extra_string": extra_string, "extra_dict": extra_dict},
|
|
|
|
|
)
|
|
|
|
|
return True
|
|
|
|
|
|
2025-03-24 14:14:14 +00:00
|
|
|
# Create a message handler to catch exceptions
|
|
|
|
|
async def message_handler(
|
|
|
|
|
message: RequestResponder[types.ServerRequest, types.ClientResult] | types.ServerNotification | Exception,
|
|
|
|
|
) -> None:
|
|
|
|
|
if isinstance(message, Exception): # pragma: no cover
|
|
|
|
|
raise message
|
2025-03-19 09:40:08 +00:00
|
|
|
|
2026-01-16 15:49:26 +00:00
|
|
|
async with Client(
|
|
|
|
|
server,
|
2025-03-24 14:14:14 +00:00
|
|
|
logging_callback=logging_collector,
|
|
|
|
|
message_handler=message_handler,
|
2026-01-16 15:49:26 +00:00
|
|
|
) as client:
|
2025-03-24 14:14:14 +00:00
|
|
|
# First verify our test tool works
|
2026-01-16 15:49:26 +00:00
|
|
|
result = await client.call_tool("test_tool", {})
|
2026-01-16 15:51:27 +01:00
|
|
|
assert result.is_error is False
|
2025-03-24 14:14:14 +00:00
|
|
|
assert isinstance(result.content[0], TextContent)
|
|
|
|
|
assert result.content[0].text == "true"
|
2025-03-19 09:40:08 +00:00
|
|
|
|
2025-03-24 14:14:14 +00:00
|
|
|
# Now send a log message via our tool
|
2026-01-16 15:49:26 +00:00
|
|
|
log_result = await client.call_tool(
|
2025-03-24 14:14:14 +00:00
|
|
|
"test_tool_with_log",
|
|
|
|
|
{
|
|
|
|
|
"message": "Test log message",
|
|
|
|
|
"level": "info",
|
|
|
|
|
"logger": "test_logger",
|
|
|
|
|
},
|
|
|
|
|
)
|
2026-01-16 15:49:26 +00:00
|
|
|
log_result_with_extra = await client.call_tool(
|
2025-12-19 09:54:03 -08:00
|
|
|
"test_tool_with_log_extra",
|
|
|
|
|
{
|
|
|
|
|
"message": "Test log message",
|
|
|
|
|
"level": "info",
|
|
|
|
|
"logger": "test_logger",
|
|
|
|
|
"extra_string": "example",
|
|
|
|
|
"extra_dict": {"a": 1, "b": 2, "c": 3},
|
|
|
|
|
},
|
|
|
|
|
)
|
2026-01-16 15:51:27 +01:00
|
|
|
assert log_result.is_error is False
|
|
|
|
|
assert log_result_with_extra.is_error is False
|
2025-12-19 09:54:03 -08:00
|
|
|
assert len(logging_collector.log_messages) == 2
|
2025-05-02 11:58:54 +01:00
|
|
|
# Create meta object with related_request_id added dynamically
|
|
|
|
|
log = logging_collector.log_messages[0]
|
|
|
|
|
assert log.level == "info"
|
|
|
|
|
assert log.logger == "test_logger"
|
|
|
|
|
assert log.data == "Test log message"
|
2025-12-19 09:54:03 -08:00
|
|
|
|
|
|
|
|
log_with_extra = logging_collector.log_messages[1]
|
|
|
|
|
assert log_with_extra.level == "info"
|
|
|
|
|
assert log_with_extra.logger == "test_logger"
|
|
|
|
|
assert log_with_extra.data == {
|
|
|
|
|
"message": "Test log message",
|
|
|
|
|
"extra_string": "example",
|
|
|
|
|
"extra_dict": {"a": 1, "b": 2, "c": 3},
|
|
|
|
|
}
|
