mssql_health_check

Instructions

Implementation Reference

• src/index.ts:701-781 (handler)

  The handler function for 'mssql_health_check' that connects to the MSSQL server, performs diagnostic queries (@@VERSION, GETDATE(), database properties), collects health metrics including response time, connection status, and optionally server metrics, and returns structured JSON response or error.

  private async handleHealthCheck(args: any) {
    const config = ConnectionSchema.parse(args);
    const { includeMetrics = true } = args;
    const startTime = Date.now();
  
    try {
      const pool = await this.getConnection(config);
      
      // Test basic connectivity
      const request = pool.request();
      const versionResult = await request.query('SELECT @@VERSION as version');
      const connectionTimeResult = await request.query('SELECT GETDATE() as server_time');
      
      // Get database status if database is specified
      let databaseInfo = null;
      if (config.database) {
        const dbRequest = pool.request();
        const dbResult = await dbRequest.query(`
          SELECT 
            DB_NAME() as database_name,
            DATABASEPROPERTYEX(DB_NAME(), 'Status') as status,
            DATABASEPROPERTYEX(DB_NAME(), 'Collation') as collation,
            DATABASEPROPERTYEX(DB_NAME(), 'Version') as version
        `);
        databaseInfo = dbResult.recordset[0];
      }
  
      const responseTime = Date.now() - startTime;
  
      const healthInfo: any = {
        status: 'healthy',
        server: config.server,
        database: config.database || 'master',
        serverVersion: versionResult.recordset[0]?.version,
        serverTime: connectionTimeResult.recordset[0]?.server_time,
        responseTime: responseTime,
        connectionPoolInfo: {
          connected: pool.connected,
          connecting: pool.connecting,
          healthy: pool.healthy
        }
      };
  
      if (databaseInfo) {
        healthInfo.databaseInfo = databaseInfo;
      }
  
      if (includeMetrics) {
        healthInfo.metrics = {
          ...this.metrics,
          activeConnections: this.connectionPools.size
        };
      }
  
      return {
        content: [
          {
            type: 'text',
            text: JSON.stringify(healthInfo, null, 2),
          },
        ],
      };
    } catch (error) {
      return {
        content: [
          {
            type: 'text',
            text: JSON.stringify({
              status: 'unhealthy',
              server: config.server,
              database: config.database || 'master',
              error: error instanceof Error ? error.message : String(error),
              responseTime: Date.now() - startTime
            }, null, 2),
          },
        ],
        isError: true,
      };
    }
  }

• src/index.ts:379-395 (registration)

  Registration of the 'mssql_health_check' tool in the ListTools response, defining its name, description, and input schema for parameters like server, port, credentials, encryption options, and includeMetrics flag.

  {
    name: 'mssql_health_check',
    description: 'Check database server health and connectivity with performance metrics',
    inputSchema: {
      type: 'object',
      properties: {
        server: { type: 'string', description: 'MSSQL Server hostname or IP address' },
        port: { type: 'number', description: 'Port number (default: 1433)', default: 1433 },
        user: { type: 'string', description: 'Username for authentication' },
        password: { type: 'string', description: 'Password for authentication' },
        encrypt: { type: 'boolean', description: 'Use encrypted connection (default: true)', default: true },
        trustServerCertificate: { type: 'boolean', description: 'Trust server certificate (default: true)', default: true },
        includeMetrics: { type: 'boolean', description: 'Include performance metrics (default: true)', default: true },
      },
      required: ['server', 'user', 'password'],
    },
  },

• src/index.ts:449-450 (registration)

  Switch case registration in the CallToolRequest handler that routes calls to the 'mssql_health_check' tool to its handler method.

  case 'mssql_health_check':
    return await this.handleHealthCheck(args);

• src/index.ts:76-84 (schema)

  Zod schema used for parsing and validating connection parameters in the health check handler (and other tools).

  const ConnectionSchema = z.object({
    server: z.string().describe('MSSQL Server hostname or IP address'),
    port: z.number().default(1433).describe('Port number (default: 1433)'),
    user: z.string().describe('Username for authentication'),
    password: z.string().describe('Password for authentication'),
    database: z.string().optional().describe('Database name (optional)'),
    encrypt: z.boolean().default(true).describe('Use encrypted connection'),
    trustServerCertificate: z.boolean().default(true).describe('Trust server certificate'),
  });