cls-mcp-server 0.2.8 → 0.3.0

package/dist/index.js

@@ -4,11 +4,13 @@ var __importDefault = (this && this.__importDefault) || function (mod) {
     return (mod && mod.__esModule) ? mod : { "default": mod };
 };
 Object.defineProperty(exports, "__esModule", { value: true });
+exports.SEARCH_TIME_TEXT_FORMAT = exports.TIMEZONE_SHANGHAI = void 0;
 const mcp_js_1 = require("@modelcontextprotocol/sdk/server/mcp.js");
 const sse_js_1 = require("@modelcontextprotocol/sdk/server/sse.js");
 const stdio_js_1 = require("@modelcontextprotocol/sdk/server/stdio.js");
 require("dotenv/config");
 const express_1 = __importDefault(require("express"));
+const moment_timezone_1 = __importDefault(require("moment-timezone"));
 const tencentcloud_sdk_nodejs_cls_1 = require("tencentcloud-sdk-nodejs-cls");
 const tencentcloud_sdk_nodejs_region_1 = require("tencentcloud-sdk-nodejs-region");
 const zod_1 = require("zod");
@@ -26,10 +28,10 @@ const MultiTopicSearchInformationSchema = zod_1.z.object({
 const SearchLogRequestSchema = {
     From: zod_1.z
         .number()
-        .describe('要检索分析的日志的起始时间，Unix时间戳（需要传毫秒粒度）。To减去From的时间范围建议不要过大，建议默认近15分钟，否则会导致返回的日志过多，影响性能。计算相对时间（如近15分钟）时，如果AI模型不知道当前时间，AI模型应该先调用GetCurrentTimestamp工具获取当前时间，再基于这个当前时间去计算相对时间。传入的参数是数字整形，如涉及加减乘除等数学运算，应传入运算结果的数字整形，不要传入一个数学运算公式。'),
+        .describe('要检索分析的日志的起始时间，Unix时间戳（需要传毫秒粒度）。To减去From的时间范围建议不要过大，建议默认近15分钟，否则会导致返回的日志过多，影响性能。计算相对时间（如近15分钟）时，如果AI模型不知道当前时间，AI模型应该先调用 GetCurrentTimestamp 工具获取当前时间，再基于这个当前时间去计算相对时间。传入的参数是数字整形，如涉及加减乘除等数学运算，应传入运算结果的数字整形，不要传入一个数学运算公式。也可以调用 ConvertTimeStringToTimestamp 直接获取时间戳参数。'),
     To: zod_1.z
         .number()
-        .describe('要检索分析的日志的结束时间，Unix时间戳（需要传毫秒粒度）。To减去From的时间范围建议不要过大，建议默认近15分钟，否则会导致返回的日志过多，影响性能。计算相对时间（如近15分钟）时，如果AI模型不知道当前时间，AI模型应该先调用GetCurrentTimestamp工具获取当前时间，再基于这个当前时间去计算相对时间。传入的参数是数字整形，如涉及加减乘除等数学运算，应传入运算结果的数字整形，不要传入一个数学运算公式。'),
+        .describe('要检索分析的日志的结束时间，Unix时间戳（需要传毫秒粒度）。To减去From的时间范围建议不要过大，建议默认近15分钟，否则会导致返回的日志过多，影响性能。计算相对时间（如近15分钟）时，如果AI模型不知道当前时间，AI模型应该先调用 GetCurrentTimestamp 工具获取当前时间，再基于这个当前时间去计算相对时间。传入的参数是数字整形，如涉及加减乘除等数学运算，应传入运算结果的数字整形，不要传入一个数学运算公式。也可以调用 ConvertTimeStringToTimestamp 直接获取时间戳参数。'),
     Query: zod_1.z.string().describe('检索分析语句，最大长度为12KB。如果不限定检索条件，可传 * 或 空字符串，可查询所有日志'),
     TopicId: zod_1.z.string().optional().describe('要检索分析的日志主题ID，仅能指定一个日志主题'),
     Topics: zod_1.z
@@ -50,7 +52,35 @@ const SearchLogRequestSchema = {
         .describe('执行统计分析时是否对原始日志先进行采样，0：自动采样；0～1：按指定采样率采样；1：不采样'),
     Region: zod_1.z.string().describe('地域信息，必传，如：ap-guangzhou'),
 };
-mcpServer.tool('SearchLog', 'Search logs based on query parameters', SearchLogRequestSchema, async ({ From, To, Query, TopicId, Topics, Sort, Limit, Offset, SamplingRate, Region: regionFromAI, }) => {
+mcpServer.registerTool('SearchLog', {
+    description: 'Search logs based on query parameters',
+    inputSchema: SearchLogRequestSchema,
+    /* outputSchema: z.object({
+      Analysis: z.boolean().describe('返回的是否为统计分析（即SQL）结果'),
+      AnalysisRecords: z.array(z.string()).describe('统计分析（即SQL）结果。Analysis为true时，返回该字段'),
+      Results: z
+        .array(
+          z.object({
+            Time: z.number().describe('日志时间，单位ms'),
+            Source: z.string().describe('日志来源IP'),
+            FileName: z.string().describe('日志文件名称'),
+            PkgId: z
+              .string()
+              .describe(
+                '日志上报请求包的ID。结合 PkgLogId 一起，可作为参数通过 DescribeLogContext 工具获取日志上下文信息。',
+              ),
+            PkgLogId: z
+              .string()
+              .describe(
+                '请求包内日志的ID。结合 PkgId 一起，可作为参数通过 DescribeLogContext 工具获取日志上下文信息。',
+              ),
+            LogJson: z.string().describe('日志内容的Json序列化字符串'),
+            HostName: z.string().describe('日志来源主机名称'),
+          }),
+        )
+        .describe('匹配检索条件的原始日志。Analysis为false时，返回该字段'),
+    }), */
+}, async ({ From, To, Query, TopicId, Topics, Sort, Limit, Offset, SamplingRate, Region: regionFromAI, }) => {
     try {
         const region = regionFromAI || process.env.TENCENTCLOUD_REGION;
         if (!region) {
@@ -101,23 +131,117 @@ mcpServer.tool('SearchLog', 'Search logs based on query parameters', SearchLogRe
         if (response.Analysis) {
             return formatResponse(response.AnalysisRecords);
         }
-        return formatResponse(response.Results?.map((result) => result?.LogJson));
+        return formatResponse(response.Results?.map((result) => ({
+            Time: result.Time,
+            Source: result.Source,
+            FileName: result.FileName,
+            PkgId: result.PkgId,
+            PkgLogId: result.PkgLogId,
+            LogJson: result.LogJson,
+            HostName: result.HostName,
+        })));
     }
     catch (e) {
         return formatResponse({ message: e?.toString ? e.toString() : e?.message, stack: e?.stack, ...e }, true);
     }
 });
-mcpServer.tool('GetTopicInfoByName', 'search topic info by topic name', {
-    searchText: zod_1.z
-        .string()
-        .optional()
-        .describe('Text to search, possible value: topic name. If not provided, will search all topics'),
-    preciseSearch: zod_1.z
-        .boolean()
-        .default(false)
-        .describe('If precise search(true) or fuzzy search(false), default false. Recommend to use fuzzy search.'),
-    region: zod_1.z.string().describe('地域信息，必传，如：ap-guangzhou'),
-}, async ({ region: regionFromAI, searchText, preciseSearch }) => {
+exports.TIMEZONE_SHANGHAI = 'Asia/Shanghai';
+exports.SEARCH_TIME_TEXT_FORMAT = 'YYYY-MM-DD HH:mm:ss.SSS';
+mcpServer.registerTool('DescribeLogContext', {
+    description: '搜索日志上下文附近的内容',
+    inputSchema: {
+        Region: zod_1.z.string().describe('地域信息，必传，如：ap-guangzhou'),
+        TopicId: zod_1.z.string().describe('要检索分析的日志主题ID，仅能指定一个日志主题'),
+        Time: zod_1.z
+            .number()
+            .describe('日志时间，单位ms。通过 SearchLog 工具检索原始日志时，Results 结构体中会返回 Time 字段。'),
+        PkgId: zod_1.z
+            .string()
+            .describe('日志上报请求包的ID。通过 SearchLog 工具检索原始日志时，Results 结构体中会返回 PkgId 字段。'),
+        PkgLogId: zod_1.z
+            .string()
+            .describe('请求包内日志的ID。通过 SearchLog 工具检索原始日志时，Results 结构体中会返回 PkgLogId 字段。'),
+        PrevLogs: zod_1.z.number().optional().default(10).describe('前${PrevLogs}条日志，默认值10。'),
+        NextLogs: zod_1.z.number().optional().default(10).describe('后${NextLogs}条日志，默认值10。'),
+        Query: zod_1.z.string().optional().describe('检索语句，对日志上下文进行过滤，不支持SQL语句。'),
+        From: zod_1.z.number().optional().describe('上下文检索的开始时间，单位ms。'),
+        To: zod_1.z.number().optional().describe('上下文检索的结束时间，单位ms。'),
+    },
+}, async ({ Region: regionFromAI, TopicId, Time, PkgId, PkgLogId, PrevLogs = 10, NextLogs = 10, Query, From, To, }) => {
+    try {
+        const region = regionFromAI || process.env.TENCENTCLOUD_REGION;
+        if (!region) {
+            throw new Error('no Region is provided.');
+        }
+        if (!TopicId) {
+            throw new Error('no TopicId is provided.');
+        }
+        if (!Time) {
+            throw new Error('no Time is provided.');
+        }
+        if (!PkgId) {
+            throw new Error('no PkgId is provided.');
+        }
+        if (!PkgLogId) {
+            throw new Error('no PkgLogId is provided.');
+        }
+        const cloudApiBaseHost = process.env.TENCENTCLOUD_API_BASE_HOST || 'tencentcloudapi.com';
+        const clsClient = new ClsClient({
+            credential: {
+                secretId: process.env.TENCENTCLOUD_SECRET_ID,
+                secretKey: process.env.TENCENTCLOUD_SECRET_KEY,
+            },
+            region,
+            profile: {
+                language: 'zh-CN',
+                httpProfile: {
+                    endpoint: `cls.${cloudApiBaseHost}`,
+                },
+            },
+        });
+        clsClient.sdkVersion = 'cls-mcp-server';
+        const capiParams = {
+            TopicId,
+            BTime: (0, moment_timezone_1.default)(Time).tz(exports.TIMEZONE_SHANGHAI).format(exports.SEARCH_TIME_TEXT_FORMAT),
+            PkgId,
+            PkgLogId: Number(PkgLogId),
+            PrevLogs,
+            NextLogs,
+            From,
+            To,
+            ...(Query && {
+                Query,
+            }),
+            ...(From && {
+                From,
+            }),
+            ...(To && {
+                To,
+            }),
+        };
+        const response = await clsClient.DescribeLogContext(capiParams);
+        return formatResponse(response);
+    }
+    catch (e) {
+        return formatResponse({ message: e?.toString ? e.toString() : e?.message, stack: e?.stack, ...e }, true);
+    }
+});
+mcpServer.registerTool('GetTopicInfoByName', {
+    description: 'search topic info by topic name',
+    inputSchema: {
+        searchText: zod_1.z
+            .string()
+            .optional()
+            .describe('Text to search, possible value: topic name. If not provided, will search all topics'),
+        preciseSearch: zod_1.z
+            .boolean()
+            .default(false)
+            .describe('If precise search(true) or fuzzy search(false), default false. Recommend to use fuzzy search.'),
+        region: zod_1.z.string().describe('地域信息，必传，如：ap-guangzhou'),
+        offset: zod_1.z.number().optional().default(0).describe('Offset of the topic list, default 0'),
+        limit: zod_1.z.number().optional().default(20).describe('Limit of the topic list, default 20'),
+    },
+}, async ({ region: regionFromAI, searchText, preciseSearch, offset = 0, limit = 20 }) => {
     try {
         const region = regionFromAI || process.env.TENCENTCLOUD_REGION;
         if (!region) {
@@ -148,6 +272,8 @@ mcpServer.tool('GetTopicInfoByName', 'search topic info by topic name', {
                 ]
                 : [],
             PreciseSearch: preciseSearch ? 1 : 0,
+            Offset: offset,
+            Limit: limit,
         });
         const topics = response?.Topics?.map((topic) => ({
             TopicName: topic.TopicName,
@@ -160,13 +286,16 @@ mcpServer.tool('GetTopicInfoByName', 'search topic info by topic name', {
         return formatResponse({ message: e?.toString ? e.toString() : e?.message, stack: e?.stack, ...e }, true);
     }
 });
-mcpServer.tool('GetRegionCodeByName', 'search region parameter by region name', {
-    searchText: zod_1.z.string().describe('region name to search, e.g. Hong Kong or 广州'),
-    language: zod_1.z
-        .string()
-        .optional()
-        .default('zh-CN')
-        .describe('search text language, "zh-CN" or "en-US", default zh-CN'),
+mcpServer.registerTool('GetRegionCodeByName', {
+    description: 'search region parameter by region name',
+    inputSchema: {
+        searchText: zod_1.z.string().describe('region name to search, e.g. Hong Kong or 广州'),
+        language: zod_1.z
+            .string()
+            .optional()
+            .default('zh-CN')
+            .describe('search text language, "zh-CN" or "en-US", default zh-CN'),
+    },
 }, async ({ searchText, language }) => {
     try {
         const cloudApiBaseHost = process.env.TENCENTCLOUD_API_BASE_HOST || 'tencentcloudapi.com';
@@ -203,13 +332,40 @@ mcpServer.tool('GetRegionCodeByName', 'search region parameter by region name',
         return formatResponse({ message: e?.toString ? e.toString() : e?.message, stack: e?.stack, ...e }, true);
     }
 });
-mcpServer.tool('GetCurrentTimestamp', 'get current timestamp in milliseconds', {}, () => formatResponse(Date.now()));
-mcpServer.tool('TextToSearchLogQuery', 'get cls SearchLog Query with natual language generated by user', {
-    Text: zod_1.z
-        .string()
-        .describe('natual language input generated by user, e.g. 查询日志条数 or Get error logs distribution over time.'),
-    Region: zod_1.z.string().describe('地域信息，必传，如：ap-guangzhou'),
-    TopicId: zod_1.z.string().optional().describe('要检索分析的日志主题ID，仅能指定一个日志主题'),
+mcpServer.registerTool('GetCurrentTimestamp', { description: 'get current timestamp in milliseconds' }, () => formatResponse(Date.now()));
+mcpServer.registerTool('ConvertTimeStringToTimestamp', {
+    description: 'convert time string to timestamp in milliseconds',
+    inputSchema: {
+        timeString: zod_1.z.string().describe('time string to convert, e.g. 2025-06-01 12:00:00'),
+        timeFormat: zod_1.z
+            .string()
+            .optional()
+            .default('%Y-%m-%d %H:%M:%S')
+            .describe('time format to use, e.g. YYYY-MM-DD HH:mm:ss'),
+        timeZone: zod_1.z.string().optional().default(exports.TIMEZONE_SHANGHAI).describe('time zone to use, e.g. Asia/Shanghai'),
+    },
+}, ({ timeString, timeFormat, timeZone }) => formatResponse(moment_timezone_1.default.tz(timeString, timeFormat, timeZone).valueOf()));
+mcpServer.registerTool('ConvertTimestampToTimeString', {
+    description: 'convert timestamp to time string',
+    inputSchema: {
+        timestamp: zod_1.z.number().describe('timestamp in milliseconds to convert, e.g. 1717286400000'),
+        timeFormat: zod_1.z
+            .string()
+            .optional()
+            .default('%Y-%m-%d %H:%M:%S')
+            .describe('time format to use, e.g. YYYY-MM-DD HH:mm:ss'),
+        timeZone: zod_1.z.string().optional().default(exports.TIMEZONE_SHANGHAI).describe('time zone to use, e.g. Asia/Shanghai'),
+    },
+}, ({ timestamp, timeFormat, timeZone }) => formatResponse((0, moment_timezone_1.default)(timestamp).tz(timeZone).format(timeFormat)));
+mcpServer.registerTool('TextToSearchLogQuery', {
+    description: 'get cls SearchLog Query with natual language generated by user',
+    inputSchema: {
+        Text: zod_1.z
+            .string()
+            .describe('natual language input generated by user, e.g. 查询日志条数 or Get error logs distribution over time.'),
+        Region: zod_1.z.string().describe('地域信息，必传，如：ap-guangzhou'),
+        TopicId: zod_1.z.string().optional().describe('要检索分析的日志主题ID，仅能指定一个日志主题'),
+    },
 }, async ({ Text, TopicId, Region: regionFromAI }) => {
     const region = regionFromAI || process.env.TENCENTCLOUD_REGION;
     if (!region) {

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "cls-mcp-server",
-  "version": "0.2.8",
+  "version": "0.3.0",
   "main": "index.js",
   "files": [
     "dist"
@@ -20,17 +20,19 @@
   "license": "ISC",
   "description": "",
   "dependencies": {
-    "@modelcontextprotocol/sdk": "^1.9.0",
+    "@modelcontextprotocol/sdk": "^1.25.1",
     "dotenv": "^16.5.0",
     "express": "^5.1.0",
-    "tencentcloud-sdk-nodejs-cls": "^4.1.18",
-    "tencentcloud-sdk-nodejs-common": "^4.1.1",
-    "tencentcloud-sdk-nodejs-region": "^4.0.997",
-    "zod": "^3.24.3"
+    "moment": "^2.30.1",
+    "moment-timezone": "^0.6.0",
+    "tencentcloud-sdk-nodejs-cls": "^4.1.158",
+    "tencentcloud-sdk-nodejs-common": "^4.1.122",
+    "tencentcloud-sdk-nodejs-region": "^4.1.137",
+    "zod": "^3.25.76"
   },
   "devDependencies": {
-    "@commitlint/cli": "^18.6.1",
-    "@commitlint/config-conventional": "^18.6.3",
+    "@commitlint/cli": "^20.2.0",
+    "@commitlint/config-conventional": "^20.2.0",
     "@types/express": "^5.0.1",
     "@types/ip": "^1.1.3",
     "@types/jest": "^29.5.0",