add verbose mode

Author: samuelhsin

README.md

@@ -87,7 +87,8 @@ If you built from source (Option 2):
         "REGION": "your_dataworks_open_api_region_id_here",
         "ALIBABA_CLOUD_ACCESS_KEY_ID": "your_alibaba_cloud_access_key_id",
         "ALIBABA_CLOUD_ACCESS_KEY_SECRET": "your_alibaba_cloud_access_key_secret",
-        "NODE_ENV": "development_or_product"
+        "NODE_ENV": "development_or_product",
+        "VERBOSE": "true"
       },
       "disabled": false,
       "autoApprove": []

build/mcp/index.js

@@ -23,7 +23,7 @@ export function createMcpServer(actions, agent, dataWorksOpenApis, options) {
             const { result = {} } = zodToMCPShape(convertInputSchemaToSchema(action?.inputSchema));
             paramsSchema = result;
         }
-        console.log(paramsSchema);
+        console.log('active tool', action.name);
         server.tool(action.name, action.description || '', paramsSchema, async (params) => {
             try {
                 // Execute the action handler with the params directly

build/openApiClient/index.js

@@ -1,5 +1,6 @@
 import OpenApi from '@alicloud/openapi-client';
 import Credential from '@alicloud/credentials';
+import { getEnvInfo, isVerboseMode } from '../utils/common.js';
 class OpenApiClient {
     /**
      * use ak and sk to init a client
@@ -32,6 +33,11 @@ class OpenApiClient {
         // 使用特定方式调用
         // import DataWorksPublic20240518 from '@alicloud/dataworks-public20240518';
         // return new DataWorksPublic20240518.default(apiConfig);
+        const verbose = isVerboseMode();
+        if (verbose) {
+            console.debug('apiConfig endpoint', apiConfig.endpoint);
+            console.debug('env info', getEnvInfo());
+        }
         // 使用泛化方式调用
         // https://help.aliyun.com/zh/sdk/developer-reference/generalized-call-node-js
         return new OpenApi.default(apiConfig);

build/tools/callTool.js

@@ -2,6 +2,7 @@
 // import * as DataWorksPublic20240518Classes from '@alicloud/dataworks-public20240518';
 import OpenApi from '@alicloud/openapi-client';
 import Util from '@alicloud/tea-util';
+import { isVerboseMode, getEnvInfo } from '../utils/common.js';
 /**
  * Get detailed and latest information about any topic using Perplexity AI.
  * @param agent Aliyun Open API instance
@@ -76,7 +77,8 @@ async function callTool(agent, apiKey, input, dataWorksOpenApis) {
         return (res?.statusCode === 200 && res?.body) ? res?.body : res;
     }
     catch (error) {
-        throw new Error(`Call tool failed: ${error.message}, api key: ${apiKey}, api request configs: ${JSON.stringify(apiRequestConfigs)}, query: ${JSON.stringify(query)}, body: ${JSON.stringify(body)}`);
+        const verbose = isVerboseMode();
+        throw new Error(`Call tool failed: ${error.message}, api key: ${apiKey}, api request configs: ${JSON.stringify(apiRequestConfigs)}, query: ${JSON.stringify(query)}, body: ${JSON.stringify(body)}${verbose ? `, env info: ${getEnvInfo()}` : ''}`);
     }
 }
 ;

build/utils/common.js

@@ -0,0 +1,38 @@
+/**
+ * 是 undefined 或 null
+ * @param value
+ * @returns
+ */
+export function isEmpty(value) {
+    return value === undefined || value === null;
+}
+/**
+ * 不是undefined null 空字串
+ * @param input
+ * @returns {boolean}
+ */
+export function isEmptyStr(input) {
+    return (input === null || input === undefined || input === '');
+}
+export function isVerboseMode() {
+    let verbose = false;
+    try {
+        const env = process?.env || {};
+        verbose = env.VERBOSE === 'true';
+    }
+    catch (e) {
+        console.error(e);
+    }
+    return verbose;
+}
+export function getEnvInfo() {
+    let envInfoStr = '';
+    try {
+        const env = process?.env || {};
+        envInfoStr = JSON.stringify(env);
+    }
+    catch (e) {
+        console.error(e);
+    }
+    return envInfoStr;
+}

package.json

@@ -1,6 +1,6 @@
 {
   "name": "alibabacloud-dataworks-mcp-server",
-  "version": "1.0.5",
+  "version": "1.0.6",
   "description": "DataWorks MCP Server: Export the DataWorks Open API to MCP Server, allowing clients that can run MCP Server to use DataWorks Open API through AI.",
   "main": "build/index.js",
   "module": "build/index.js",
@@ -37,7 +37,7 @@
   "author": "DataWorks",
   "license": "Apache-2.0",
   "dependencies": {
-    "@alicloud/credentials": "^2.4.2",
+    "@alicloud/credentials": "2.4.2",
     "@alicloud/dataworks-public20240518": "^6.0.2",
     "@alicloud/openapi-client": "^0.4.13",
     "@alicloud/openapi-util": "^0.3.2",
@@ -61,6 +61,9 @@
     "tailwindcss": "^3.0.0",
     "typescript": "^5.7.3"
   },
+  "resolutions": {
+    "@alicloud/credentials": "2.4.2"
+  },
   "packageManager": "[email protected]",
   "publishConfig": {
     "registry": "https://registry.npmjs.org"

pnpm-lock.yaml

@@ -37,7 +37,7 @@ export function createMcpServer(
       paramsSchema = result;
     }
 
-    console.log(paramsSchema);
+    console.log('active tool', action.name);
 
     server.tool(
       action.name,

src/mcp/index.ts

@@ -3,6 +3,7 @@ import Credential from '@alicloud/credentials';
 import Util from '@alicloud/tea-util';
 import tea from '@alicloud/tea-typescript';
 import typeClient from '@alicloud/openapi-client';
+import { getEnvInfo, isVerboseMode } from '../utils/common.js';
 
 type Error = { message: string; };
 
@@ -55,6 +56,12 @@ class OpenApiClient {
     // import DataWorksPublic20240518 from '@alicloud/dataworks-public20240518';
     // return new DataWorksPublic20240518.default(apiConfig);
 
+    const verbose = isVerboseMode();
+    if (verbose) {
+      console.debug('apiConfig endpoint', apiConfig.endpoint);
+      console.debug('env info', getEnvInfo());
+    }
+
     // 使用泛化方式调用
     // https://help.aliyun.com/zh/sdk/developer-reference/generalized-call-node-js
     return new OpenApi.default(apiConfig);

src/openApiClient/index.ts

@@ -6,6 +6,7 @@ import Util from '@alicloud/tea-util';
 import tea from '@alicloud/tea-typescript';
 import { OpenApiClientInstance } from "../openApiClient/index.js";
 import { AlibabaCloudOpenApiInterface, ApiMethod, IAlibabaCloudOpenApiResponse } from '../types/apibabaCloudApi.js';
+import { isVerboseMode, getEnvInfo } from '../utils/common.js';
 
 /**
  * Get detailed and latest information about any topic using Perplexity AI.
@@ -94,7 +95,8 @@ async function callTool(
     return (res?.statusCode === 200 && res?.body) ? res?.body : res;
 
   } catch (error: any) {
-    throw new Error(`Call tool failed: ${error.message}, api key: ${apiKey}, api request configs: ${JSON.stringify(apiRequestConfigs)}, query: ${JSON.stringify(query)}, body: ${JSON.stringify(body)}`);
+    const verbose = isVerboseMode();
+    throw new Error(`Call tool failed: ${error.message}, api key: ${apiKey}, api request configs: ${JSON.stringify(apiRequestConfigs)}, query: ${JSON.stringify(query)}, body: ${JSON.stringify(body)}${verbose ? `, env info: ${getEnvInfo()}` : ''}`);
   }
 };
 

src/tools/callTool.ts

@@ -0,0 +1,40 @@
+/**
+ * 是 undefined 或 null
+ * @param value
+ * @returns
+ */
+export function isEmpty(value: any) {
+  return value === undefined || value === null;
+}
+
+
+/**
+ * 不是undefined null 空字串
+ * @param input
+ * @returns {boolean}
+ */
+export function isEmptyStr(input: any) {
+  return (input === null || input === undefined || input === '');
+}
+
+export function isVerboseMode() {
+  let verbose: boolean = false;
+  try {
+    const env = process?.env || {};
+    verbose = env.VERBOSE === 'true';
+  } catch (e) {
+    console.error(e);
+  }
+  return verbose;
+}
+
+export function getEnvInfo() {
+  let envInfoStr: string = '';
+  try {
+    const env = process?.env || {};
+    envInfoStr = JSON.stringify(env);
+  } catch (e) {
+    console.error(e);
+  }
+  return envInfoStr;
+}