ModelContextProtocol TypeScript SDK 中的日志功能实现指南

前言

在使用ModelContextProtocol TypeScript SDK开发MCP服务器时，开发者经常需要记录服务器运行状态和重要事件。SDK提供了sendLoggingMessage方法来实现这一功能，但初次使用时可能会遇到一些配置问题。

问题现象

当开发者尝试使用server.sendLoggingMessage方法记录服务器启动信息时，控制台会抛出错误提示"Server does not support logging"。这表明服务器实例没有正确配置日志功能支持。

解决方案

要解决这个问题，需要在创建Server实例时显式声明日志功能支持。以下是正确配置的代码示例：

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

const server = new Server(
  {
    name: "my-mcp-server",
    version: "1.0.0"
  }, 
  {
    capabilities: {
      logging: {},  // 关键配置，启用日志功能
      resources: {},
      tools: {},
    }
  }
);

实现原理

ModelContextProtocol SDK采用能力声明模式设计，服务器需要明确声明支持的功能集。这种设计有以下几个优点：

1. 显式依赖：开发者可以清晰地了解服务器支持的功能
2. 安全控制：避免意外使用未声明的功能
3. 资源优化：只加载必要的功能模块

进阶用法

配置好日志功能后，可以灵活使用sendLoggingMessage方法记录不同级别的日志：

// 记录信息级别日志
server.sendLoggingMessage({
  level: "info",
  data: "Server started successfully",
});

// 记录警告级别日志
server.sendLoggingMessage({
  level: "warn",
  data: "Resource usage approaching limit",
});

// 记录错误级别日志
server.sendLoggingMessage({
  level: "error",
  data: "Database connection failed",
});

最佳实践建议

1. 初始化检查：在服务器启动时记录初始化状态
2. 关键操作日志：对重要业务操作添加日志记录
3. 错误处理：在catch块中记录错误详情
4. 性能监控：记录关键操作的执行时间
5. 日志分级：合理使用不同日志级别(info/warn/error)

总结

ModelContextProtocol TypeScript SDK提供了完善的日志功能支持，但需要开发者正确配置后才能使用。通过显式声明日志能力，开发者可以构建更健壮、更易维护的MCP服务器应用。合理使用日志功能不仅能帮助调试，还能为系统运维提供重要依据。