ModelContextProtocol TypeScript SDK 日志功能实现详解

背景介绍

ModelContextProtocol（简称MCP）是一个用于构建AI应用和工具的协议框架。在其TypeScript SDK中，日志功能是开发者调试和监控服务器运行状态的重要工具。本文将深入分析如何在MCP服务器中正确实现日志功能。

核心问题分析

在MCP TypeScript SDK中，开发者可能会遇到无法使用sendLoggingMessage方法的问题。这通常是由于以下两个原因造成的：

1. 使用了错误的类（McpServer而非Server）
2. 未正确配置日志能力

正确实现方法

1. 使用正确的Server类

MCP SDK提供了两种服务器类：

• McpServer：基础服务器类
• Server：完整功能服务器类，包含日志等扩展功能

要实现日志功能，必须使用Server类：

import { Server } from "@modelcontextprotocol/sdk/server/index.js";

2. 配置服务器能力

在初始化服务器时，必须显式声明日志能力：

const server = new Server({
    name: "my-server",
    version: "1.0.0"
}, {
    capabilities: {
        logging: {},  // 启用日志功能
        // 其他能力...
    }
});

3. 连接传输层

日志功能需要依赖传输层，因此必须在建立传输连接后才能使用：

import { StdioServerTransport } from "@modelcontextprotocol/sdk/server/stdio.js";

const transport = new StdioServerTransport();
await server.connect(transport);

4. 发送日志消息

连接建立后，即可使用sendLoggingMessage方法：

server.sendLoggingMessage({
    level: "info",  // 日志级别：error/warn/info/debug
    data: "Server started successfully"  // 日志内容
});

常见错误解决方案

错误1：方法不存在

现象：sendLoggingMessage is not defined

原因：使用了McpServer而非Server

解决方案：改用Server类

错误2：不支持日志能力

现象：Server does not support logging

原因：未在服务器配置中声明日志能力

解决方案：在服务器初始化时添加logging: {}配置

最佳实践建议

1. 初始化检查：在发送日志前，检查服务器是否支持日志功能
2. 错误处理：对日志发送操作进行try-catch包装
3. 日志分级：合理使用不同日志级别（error/warn/info/debug）
4. 结构化日志：data字段可以传递结构化数据，便于分析

try {
    server.sendLoggingMessage({
        level: "debug",
        data: {
            event: "startup",
            timestamp: Date.now(),
            details: {
                memoryUsage: process.memoryUsage()
            }
        }
    });
} catch (error) {
    console.error("Failed to send log:", error);
}

总结

MCP TypeScript SDK的日志功能是一个强大但需要正确配置的工具。通过使用正确的Server类、声明日志能力、建立传输连接，开发者可以充分利用这一功能来监控和调试服务器运行状态。遵循本文的指导，可以避免常见的配置错误，实现稳定可靠的日志记录功能。