@dynatrace-oss/dynatrace-mcp-server 0.9.1 → 0.10.0

package/README.md

@@ -321,6 +321,7 @@ Depending on the features you are using, the following scopes are needed:
 - `storage:system:read` - needed for `execute_dql` tool to read System Data from Grail
 - `storage:user.events:read` - needed for `execute_dql` tool to read User events from Grail
 - `storage:user.sessions:read` - needed for `execute_dql` tool to read User sessions from Grail
+- `storage:smartscape:read` - needed for `execute_dql` tool to read Smartscape Data
 - `davis-copilot:conversations:execute` - execute conversational skill (chat with Copilot)
 - `davis-copilot:nl2dql:execute` - execute Davis Copilot Natural Language (NL) to DQL skill
 - `davis-copilot:dql2nl:execute` - execute DQL to Natural Language (NL) skill

package/dist/capabilities/find-monitored-entity-by-name.js

@@ -1,6 +1,6 @@
 "use strict";
 Object.defineProperty(exports, "__esModule", { value: true });
-exports.findMonitoredEntitiesByName = exports.generateDqlSearchEntityCommand = void 0;
+exports.findMonitoredEntitiesByName = exports.findMonitoredEntityViaSmartscapeByName = exports.generateDqlSearchEntityCommand = void 0;
 const execute_dql_1 = require("./execute-dql");
 const dynatrace_entity_types_1 = require("../utils/dynatrace-entity-types");
 /**
@@ -22,10 +22,35 @@ const generateDqlSearchEntityCommand = (entityNames, extendedSearch) => {
 };
 exports.generateDqlSearchEntityCommand = generateDqlSearchEntityCommand;
 /**
- * Find a monitored entity by name via DQL
+ * Find a monitored entity via "smartscapeNodes" by name via DQL
  * @param dtClient
- * @param entityName
- * @returns A string with the entity details like id, name and type, or an error message if no entity was found
+ * @param entityNames Array of entitiy names to search for
+ * @returns An array with the entity details like id, name and type
+ */
+const findMonitoredEntityViaSmartscapeByName = async (dtClient, entityNames) => {
+    const dql = `smartscapeNodes "*" | search "*${entityNames.join('*" OR "*')}*" | fields id, name, type`;
+    console.error(`Executing DQL: ${dql}`);
+    try {
+        const smartscapeResult = await (0, execute_dql_1.executeDql)(dtClient, { query: dql });
+        if (smartscapeResult && smartscapeResult.records && smartscapeResult.records.length > 0) {
+            // return smartscape results if we found something
+            return smartscapeResult;
+        }
+    }
+    catch (error) {
+        // ignore errors here, as smartscapeNodes may not be ready for all environments/users
+        console.error('Error while querying smartscapeNodes:', error);
+    }
+    console.error('No results from smartscapeNodes');
+    return null;
+};
+exports.findMonitoredEntityViaSmartscapeByName = findMonitoredEntityViaSmartscapeByName;
+/**
+ * Find a monitored entity via "dt.entity.${entityType}" by name via DQL
+ * @param dtClient
+ * @param entityNames Array of entitiy names to search for
+ * @param extendedSearch If true, search over all entity types, otherwise only basic ones
+ * @returns An array with the entity details like id, name and type
  */
 const findMonitoredEntitiesByName = async (dtClient, entityNames, extendedSearch) => {
     // construct a DQL statement for searching the entityName over all entity types

package/dist/index.js

@@ -27,6 +27,7 @@ const getDynatraceEnv_1 = require("./getDynatraceEnv");
 const telemetry_openkit_1 = require("./utils/telemetry-openkit");
 const dynatrace_entity_types_1 = require("./utils/dynatrace-entity-types");
 const grail_budget_tracker_1 = require("./utils/grail-budget-tracker");
+const dynatrace_connection_utils_1 = require("./utils/dynatrace-connection-utils");
 // Load environment variables from .env file if available, and suppress warnings/logging to stdio
 // as it breaks MCP communication when using stdio transport
 const dotEnvOutput = (0, dotenv_1.config)({ quiet: true });
@@ -42,6 +43,7 @@ else {
     console.error(`.env file loaded successfully - loaded ${dotEnvOutput.parsed ? Object.keys(dotEnvOutput.parsed).length : 0} environment variables: ${Object.keys(dotEnvOutput.parsed || {}).join(', ')}`);
 }
 const DT_MCP_AUTH_CODE_FLOW_OAUTH_CLIENT_ID = 'dt0s08.dt-app-local'; // ToDo: Register our own oauth client
+// Base Scopes for MCP Server tools
 let scopesBase = [
     'app-engine:apps:run', // needed for environmentInformationClient
     'app-engine:functions:run', // needed for environmentInformationClient
@@ -53,7 +55,8 @@ const allRequiredScopes = scopesBase.concat([
     'storage:events:read', // Read events from Grail
     'storage:buckets:read', // Read all system data stored on Grail
     'storage:security.events:read', // Read Security events from Grail
-    'storage:entities:read', // Read Entities from Grail
+    'storage:entities:read', // Read classic Entities
+    'storage:smartscape:read', // Read Smartscape Entities from Grail
     'storage:logs:read', // Read logs for reliability guardian validations
     'storage:metrics:read', // Read metrics for reliability guardian validations
     'storage:bizevents:read', // Read bizevents for reliability guardian validations
@@ -74,57 +77,6 @@ const allRequiredScopes = scopesBase.concat([
     // Communication scopes
     'email:emails:send', // Send emails
 ]);
-/**
- * Performs a connection test to the Dynatrace environment.
- * Throws an error if the connection or authentication fails.
- */
-async function testDynatraceConnection(dtEnvironment, oauthClientId, oauthClientSecret, dtPlatformToken) {
-    const dtClient = await (0, dynatrace_clients_1.createDtHttpClient)(dtEnvironment, oauthClientId && !oauthClientSecret ? allRequiredScopes : scopesBase, oauthClientId, oauthClientSecret, dtPlatformToken);
-    const environmentInformationClient = new client_platform_management_service_1.EnvironmentInformationClient(dtClient);
-    // This call will fail if authentication is incorrect.
-    await environmentInformationClient.getEnvironmentInformation();
-}
-function handleClientRequestError(error) {
-    let additionalErrorInformation = '';
-    if (error.response.status === 403) {
-        additionalErrorInformation =
-            'Note: Your user or service-user is most likely lacking the necessary permissions/scopes for this API Call.';
-    }
-    return `Client Request Error: ${error.message} with HTTP status: ${error.response.status}. ${additionalErrorInformation} (body: ${JSON.stringify(error.body)})`;
-}
-/**
- * Try to connect to Dynatrace environment with retries and exponential backoff.
- */
-async function retryTestDynatraceConnection(dtEnvironment, oauthClientId, oauthClientSecret, dtPlatformToken) {
-    let retryCount = 0;
-    const maxRetries = 3; // Max retries
-    const delayMs = 2000; // Initial delay of 2 seconds
-    while (true) {
-        try {
-            console.error(`Testing connection to Dynatrace environment: ${dtEnvironment}... (Attempt ${retryCount + 1} of ${maxRetries})`);
-            await testDynatraceConnection(dtEnvironment, oauthClientId, oauthClientSecret, dtPlatformToken);
-            console.error(`Successfully connected to the Dynatrace environment at ${dtEnvironment}.`);
-            break;
-        }
-        catch (error) {
-            console.error(`Error: Could not connect to the Dynatrace environment at ${dtEnvironment}.`);
-            if ((0, shared_errors_1.isClientRequestError)(error)) {
-                console.error(handleClientRequestError(error));
-            }
-            else {
-                console.error(`Error: ${error.message}`);
-            }
-            retryCount++;
-            if (retryCount >= maxRetries) {
-                console.error(`Fatal: Maximum number of connection retries (${maxRetries}) exceeded. Exiting.`);
-                throw new Error(`Failed to connect to Dynatrace environment ${dtEnvironment} after ${maxRetries} attempts. Most likely your configuration is incorrect. Last error: ${error.message}`, { cause: error });
-            }
-            const delay = Math.pow(2, retryCount) * delayMs; // Exponential backoff
-            console.error(`Retrying in ${delay / 1000} seconds...`);
-            await new Promise((resolve) => setTimeout(resolve, delay));
-        }
-    }
-}
 const main = async () => {
     console.error(`Initializing Dynatrace MCP Server v${(0, version_1.getPackageJsonVersion)()}...`);
     // read Environment variables
@@ -139,25 +91,10 @@ const main = async () => {
     // Unpack environment variables
     let { oauthClientId, oauthClientSecret, dtEnvironment, dtPlatformToken, slackConnectionId, grailBudgetGB } = dynatraceEnv;
     // Infer OAuth auth code flow if no OAuth Client credentials are provided
-    // -> configure default OAuth client ID for auth code flow
     if (!oauthClientId && !oauthClientSecret && !dtPlatformToken) {
         console.error('No OAuth credentials or platform token provided - switching to OAuth authorization code flow.');
         oauthClientId = DT_MCP_AUTH_CODE_FLOW_OAUTH_CLIENT_ID; // Default OAuth client ID for auth code flow
     }
-    // Test connection on startup
-    try {
-        // Depending on the authentication type, there are multiple pitfalls
-        // * For Platform Tokens, we can just try to access "get environment info" and we will know whether it works
-        // * For Oauth Client Credentials flow, we can also try to request an access token upfront with limited scopes, and verify whether everything works
-        // * for Oauth Auth Code flow, we can only verify whether the client ID is valid and the OAuth verifier call works, but we can't verify whether the user will be able to authenticate successfully
-        await retryTestDynatraceConnection(dtEnvironment, oauthClientId, oauthClientSecret, dtPlatformToken);
-    }
-    catch (err) {
-        console.error(err.message);
-        process.exit(2);
-    }
-    // Ready to start the server
-    console.error(`Starting Dynatrace MCP Server v${(0, version_1.getPackageJsonVersion)()}...`);
     // Initialize usage tracking
     const telemetry = (0, telemetry_openkit_1.createTelemetry)();
     await telemetry.trackMcpServerStart();
@@ -189,6 +126,51 @@ const main = async () => {
         return await (0, dynatrace_clients_1.createDtHttpClient)(dtEnvironment, oauthClientId && !oauthClientSecret ? allRequiredScopes : scopes, // Always use all scopes for maximum reusability
         oauthClientId, oauthClientSecret, dtPlatformToken);
     };
+    // Try to establish a Dynatrace connection upfront, to see if everything is configured properly
+    console.error(`Testing connection to Dynatrace environment: ${dtEnvironment}...`);
+    // First, we will try a simple "fetch" to connect to dtEnvironment, without authentication
+    // This should help to see if DNS lookup works, TCP connection can be established, and TLS handshake works
+    try {
+        const response = await fetch(`${dtEnvironment}`).then((response) => response.text());
+        // check response
+        if (response && response.length > 0) {
+            if (response.includes('Authentication required')) {
+                // all good - we reached the environment and authentication is required, which is going to be the next step
+            }
+            else {
+                console.error(`⚠️ Tried to contact ${dtEnvironment}, got the following response: ${response}`);
+                // Note: We won't error out yet, but this information could already be helpful for troubleshooting
+            }
+        }
+        else {
+            throw new Error('No response received');
+        }
+    }
+    catch (error) {
+        console.error(`❌ Failed to connect to Dynatrace environment ${dtEnvironment}:`, error.message);
+        console.error(error);
+        process.exit(3);
+    }
+    // Second, we will try with proper authentication
+    try {
+        const dtClient = await createAuthenticatedHttpClient(scopesBase);
+        const environmentInformationClient = new client_platform_management_service_1.EnvironmentInformationClient(dtClient);
+        await environmentInformationClient.getEnvironmentInformation();
+        console.error(`✅ Successfully connected to the Dynatrace environment at ${dtEnvironment}.`);
+    }
+    catch (error) {
+        if ((0, shared_errors_1.isClientRequestError)(error)) {
+            console.error(`❌ Failed to connect to Dynatrace environment ${dtEnvironment}:`, (0, dynatrace_connection_utils_1.handleClientRequestError)(error));
+        }
+        else {
+            console.error(`❌ Failed to connect to Dynatrace environment ${dtEnvironment}:`, error.message);
+            // Logging more exhaustive error details for troubleshooting
+            console.error(error);
+        }
+        process.exit(2);
+    }
+    // Ready to start the server
+    console.error(`Starting Dynatrace MCP Server v${(0, version_1.getPackageJsonVersion)()}...`);
     // quick abstraction/wrapper to make it easier for tools to reply text instead of JSON
     const tool = (name, description, paramsSchema, annotations, cb) => {
         const wrappedCb = async (args) => {
@@ -210,11 +192,11 @@ const main = async () => {
                 // check if it's an error originating from the Dynatrace SDK / API Gateway and provide an appropriate message to the user
                 if ((0, shared_errors_1.isClientRequestError)(error)) {
                     return {
-                        content: [{ type: 'text', text: handleClientRequestError(error) }],
+                        content: [{ type: 'text', text: (0, dynatrace_connection_utils_1.handleClientRequestError)(error) }],
                         isError: true,
                     };
                 }
-                // else: We don't know what kind of error happened - best-case we can provide error.message
+                // else: We don't know what kind of error happened - best case we can log the error and provide error.message as a tool response
                 console.log(error);
                 return {
                     content: [{ type: 'text', text: `Error: ${error.message}` }],
@@ -381,22 +363,42 @@ const main = async () => {
     }, {
         readOnlyHint: true,
     }, async ({ entityNames, maxEntitiesToDisplay, extendedSearch }) => {
-        const dtClient = await createAuthenticatedHttpClient(scopesBase.concat('storage:entities:read'));
+        const dtClient = await createAuthenticatedHttpClient(scopesBase.concat('storage:entities:read', 'storage:smartscape:read'));
+        const smartscapeResult = await (0, find_monitored_entity_by_name_1.findMonitoredEntityViaSmartscapeByName)(dtClient, entityNames);
+        if (smartscapeResult && smartscapeResult.records && smartscapeResult.records.length > 0) {
+            // Filter valid entities first, to ensure we display up to maxEntitiesToDisplay entities
+            const validSmartscapeEntities = smartscapeResult.records.filter((entity) => !!(entity && entity.id && entity.type && entity.name));
+            let resp = `Found ${validSmartscapeEntities.length} monitored entities via Smartscape! Displaying the first ${Math.min(maxEntitiesToDisplay, validSmartscapeEntities.length)} valid entities:\n`;
+            validSmartscapeEntities.slice(0, maxEntitiesToDisplay).forEach((entity) => {
+                resp += `- Entity '${entity.name}' of entity-type '${entity.type}' has entity id '${entity.id}' and tags ${entity['tags'] ? JSON.stringify(entity['tags']) : 'none'} - DQL Filter: '| filter dt.smartscape.${String(entity.type).toLowerCase()} == "${entity.id}"'\n`;
+            });
+            resp +=
+                '\n\n**Next Steps:**\n' +
+                    '1. Fetch more details about the entity, using the `execute_dql` tool with the following DQL Statement: "smartscapeNodes \"<entity-type>\" | filter id == <entity-id>"\n' +
+                    '2. Perform a sanity check that found entities are actually the ones you are looking for, by comparing name and by type (hosts vs. containers vs. apps vs. functions) and technology (Java, TypeScript, .NET) with what is available in the local source code repo.\n' +
+                    '3. Find and investigate available metrics for relevant entities, by using the `execute_dql` tool with the following DQL statement: "fetch metric.series | filter dt.smartscape.<entity-type> == <entity-id> | limit 20"\n' +
+                    '4. Find out whether any problems exist for this entity using the `list_problems` or `list_vulnerabilities` tool, and the provided DQL-Filter\n' +
+                    '5. Explore dependency & relationships with: "smartscapeEdges \"*\" | filter source_id == <entity-id> or target_id == <entity-id>" to list inbound/outbound edges (depends_on, dependency_of, owned_by, part_of) for graph context\n';
+            return resp;
+        }
+        // If no result from Smartscape, try the classic entities API
         const result = await (0, find_monitored_entity_by_name_1.findMonitoredEntitiesByName)(dtClient, entityNames, extendedSearch);
         if (result && result.records && result.records.length > 0) {
-            let resp = `Found ${result.records.length} monitored entities! Displaying the first ${maxEntitiesToDisplay} entities:\n`;
+            // Filter valid entities first, to ensure we display up to maxEntitiesToDisplay entities
+            const validClassicEntities = result.records.filter((entity) => !!(entity && entity.id && entity.type && entity.name));
+            let resp = `Found ${validClassicEntities.length} monitored entities! Displaying the first ${Math.min(maxEntitiesToDisplay, validClassicEntities.length)} entities:\n`;
             // iterate over dqlResponse and create a string with the problem details, but only show the top maxEntitiesToDisplay problems
-            result.records.slice(0, maxEntitiesToDisplay).forEach((entity) => {
+            validClassicEntities.slice(0, maxEntitiesToDisplay).forEach((entity) => {
                 if (entity && entity.id) {
                     const entityType = (0, dynatrace_entity_types_1.getEntityTypeFromId)(String(entity.id));
-                    resp += `- Entity '${entity['entity.name']}' of type '${entity['entity.type']}' has entity id '${entity.id}' and tags ${entity['tags'] ? entity['tags'] : 'none'} - Use the DQL Filter: '| filter ${entityType} == "${entity.id}"'\n`;
+                    resp += `- Entity '${entity['entity.name']}' of entity-type '${entity['entity.type']}' has entity id '${entity.id}' and tags ${entity['tags'] ? entity['tags'] : 'none'} - DQL Filter: '| filter ${entityType} == "${entity.id}"'\n`;
                 }
             });
             resp +=
                 '\n\n**Next Steps:**\n' +
-                    '1. Try to fetch more details about the entity, using the `execute_dql` tool with "describe(dt.entity.<entity-type>)", and "fetch dt.entity.<entity-type> | filter id == <entity-id> | fieldsAdd <field-1>, <field2>, ..."\n' +
+                    '1. Fetch more details about the entity, using the `execute_dql` tool with the following DQL Statements: "describe(dt.entity.<entity-type>)", and "fetch dt.entity.<entity-type> | filter id == <entity-id> | fieldsAdd <field-1>, <field-2>, ..."\n' +
                     '2. Perform a sanity check that found entities are actually the ones you are looking for, by comparing name and by type (hosts vs. containers vs. apps vs. functions) and technology (Java, TypeScript, .NET) with what is available in the local source code repo.\n' +
-                    '3. Find and investigate available metrics for relevant entities, by using the `execute_dql` tool with the following DQL statement: "fetch metric.series | filter dt.entity.<entity-type> == <entity-id>"\n' +
+                    '3. Find and investigate available metrics for relevant entities, by using the `execute_dql` tool with the following DQL statement: "fetch metric.series | filter dt.entity.<entity-type> == <entity-id> | limit 20"\n' +
                     '4. Find out whether any problems exist for this entity using the `list_problems` or `list_vulnerabilities` tool, and the provided DQL-Filter\n';
             return resp;
         }
@@ -445,20 +447,26 @@ const main = async () => {
         }
         return resp;
     });
-    tool('execute_dql', 'Get Logs, Metrics, Spans or Events from Dynatrace GRAIL by executing a Dynatrace Query Language (DQL) statement. ' +
+    tool('execute_dql', 'Get data like Logs, Metrics, Spans, Events, or Entity Data from Dynatrace GRAIL by executing a Dynatrace Query Language (DQL) statement. ' +
         'Use the "generate_dql_from_natural_language" tool upfront to generate or refine a DQL statement based on your request. ' +
         'To learn about possible fields available for filtering, use the query "fetch dt.semantic_dictionary.models | filter data_object == \"logs\""', {
         dqlStatement: zod_1.z
             .string()
-            .describe('DQL Statement (Ex: "fetch [logs, spans, events], from: now()-4h, to: now() | filter <some-filter> | summarize count(), by:{some-fields}.", or for metrics: "timeseries { avg(<metric-name>), value.A = avg(<metric-name>, scalar: true) }"). ' +
+            .describe('DQL Statement (Ex: "fetch [logs, spans, events, metric.series, ...], from: now()-4h, to: now() [| filter <some-filter>] [| summarize count(), by:{some-fields}]", or for metrics: "timeseries { avg(<metric-name>), value.A = avg(<metric-name>, scalar: true) }", or for entities via smartscape: "smartscapeNodes \"[*, HOST, PROCESS, ...]\" [| filter id == "<ENTITY-ID>"]"). ' +
             'When querying data for a specific entity, call the `find_entity_by_name` tool first to get an appropriate filter like `dt.entity.service == "SERVICE-1234"` or `dt.entity.host == "HOST-1234"` to be used in the DQL statement. '),
+        recordLimit: zod_1.z.number().optional().default(100).describe('Maximum number of records to return (default: 100)'),
+        recordSizeLimitMB: zod_1.z
+            .number()
+            .optional()
+            .default(1)
+            .describe('Maximum size of the returned records in MB (default: 1MB)'),
     }, {
         // not readonly (DQL statements may modify things), not idempotent (may change over time)
         readOnlyHint: false,
         idempotentHint: false,
         // while we are not strictly talking to the open world here, the response from execute DQL could interpreted as a web-search, which often is referred to open-world
         openWorldHint: true,
-    }, async ({ dqlStatement }) => {
+    }, async ({ dqlStatement, recordLimit = 100, recordSizeLimitMB = 1 }) => {
         // Create a HTTP Client that has all storage:*:read scopes
         const dtClient = await createAuthenticatedHttpClient(scopesBase.concat('storage:buckets:read', // Read all system data stored on Grail
         'storage:logs:read', // Read logs for reliability guardian validations
@@ -470,8 +478,9 @@ const main = async () => {
         'storage:system:read', // Read System Data from Grail
         'storage:user.events:read', // Read User events from Grail
         'storage:user.sessions:read', // Read User sessions from Grail
-        'storage:security.events:read'));
-        const response = await (0, execute_dql_1.executeDql)(dtClient, { query: dqlStatement }, grailBudgetGB);
+        'storage:security.events:read', // Read Security events from Grail
+        'storage:smartscape:read'));
+        const response = await (0, execute_dql_1.executeDql)(dtClient, { query: dqlStatement, maxResultRecords: recordLimit, maxResultBytes: recordSizeLimitMB * 1024 * 1024 }, grailBudgetGB);
         if (!response) {
             return 'DQL execution failed or returned no result.';
         }
@@ -509,6 +518,9 @@ const main = async () => {
         if (response.sampled !== undefined && response.sampled) {
             result += `- **⚠️ Sampling Used:** Yes (results may be approximate)\n`;
         }
+        if (response.records.length === recordLimit) {
+            result += `- **⚠️ Record Limit Reached:** The result set was limited to ${recordLimit} records. Consider changing your query with a smaller timeframe, an aggregation or a more concise filter. Alternatively, increase the recordLimit if you expect more results.\n`;
+        }
         result += `\n📋 **Query Results**: (${response.records?.length || 0} records):\n\n`;
         result += `\`\`\`json\n${JSON.stringify(response.records, null, 2)}\n\`\`\``;
         return result;

package/dist/utils/dynatrace-connection-utils.js

@@ -0,0 +1,11 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.handleClientRequestError = handleClientRequestError;
+function handleClientRequestError(error) {
+    let additionalErrorInformation = '';
+    if (error.response.status === 403) {
+        additionalErrorInformation =
+            'Note: Your user or service-user is most likely lacking the necessary permissions/scopes for this API Call.';
+    }
+    return `Client Request Error: ${error.message} with HTTP status: ${error.response.status}. ${additionalErrorInformation} (body: ${JSON.stringify(error.body)})`;
+}

package/dist/utils/telemetry-openkit.js

@@ -215,8 +215,8 @@ function createTelemetry() {
         return new DynatraceMcpTelemetry();
     }
     catch (e) {
-        // Failed to initialize
-        console.error(e);
+        // Failed to initialize (unexpected). Log concise message without stack trace spam.
+        console.error('Dynatrace Telemetry initialization failed:', e.message);
         // fallback to NoOp Telemetry
         return new NoOpTelemetry();
     }

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@dynatrace-oss/dynatrace-mcp-server",
-  "version": "0.9.1",
+  "version": "0.10.0",
   "mcpName": "io.github.dynatrace-oss/Dynatrace-mcp",
   "description": "Model Context Protocol (MCP) server for Dynatrace",
   "keywords": [