@dynatrace-oss/dynatrace-mcp-server 1.3.1 → 1.5.0-beta.1

package/README.md

@@ -24,6 +24,8 @@
   </a>
 </h4>
 
+> 🚀 **Try out our brand new [Remote Dynatrace MCP Server](https://www.dynatrace.com/hub/detail/dynatrace-mcp-server/)!** Now available - no local setup required, connect instantly to your Dynatrace environment from any MCP-compatible client.
+
 The local _Dynatrace MCP server_ allows AI Assistants to interact with the [Dynatrace](https://www.dynatrace.com/) observability platform,
 bringing real-time observability data directly into your development workflow.
 

package/dist/capabilities/execute-dql.js

@@ -34,6 +34,7 @@ const createResultAndLog = (queryResult, logPrefix, budgetLimitGB) => {
     const result = {
         records: queryResult.records,
         metadata: queryResult.metadata,
+        types: queryResult.types ?? [],
         scannedBytes,
         scannedRecords: queryResult.metadata?.grail?.scannedRecords,
         executionTimeMilliseconds: queryResult.metadata?.grail?.executionTimeMilliseconds,

package/dist/index.js

@@ -3,10 +3,14 @@
 Object.defineProperty(exports, "__esModule", { value: true });
 const client_platform_management_service_1 = require("@dynatrace-sdk/client-platform-management-service");
 const shared_errors_1 = require("@dynatrace-sdk/shared-errors");
+// Dynamically imported below (ESM-only package)
+// import { registerAppTool, registerAppResource, RESOURCE_MIME_TYPE } from '@modelcontextprotocol/ext-apps/server';
 const stdio_js_1 = require("@modelcontextprotocol/sdk/server/stdio.js");
 const streamableHttp_js_1 = require("@modelcontextprotocol/sdk/server/streamableHttp.js");
 const mcp_js_1 = require("@modelcontextprotocol/sdk/server/mcp.js");
 const node_http_1 = require("node:http");
+const node_fs_1 = require("node:fs");
+const node_path_1 = require("node:path");
 const commander_1 = require("commander");
 const zod_1 = require("zod");
 const version_1 = require("./utils/version");
@@ -31,6 +35,7 @@ const dynatrace_connection_utils_1 = require("./utils/dynatrace-connection-utils
 const proxy_config_1 = require("./utils/proxy-config");
 const list_exceptions_1 = require("./capabilities/list-exceptions");
 const notebooks_1 = require("./capabilities/notebooks");
+const environment_url_parser_1 = require("./utils/environment-url-parser");
 const DT_MCP_AUTH_CODE_FLOW_OAUTH_CLIENT_ID = 'dt0s12.local-dt-mcp-server';
 // Rate limiting state: store timestamps of tool calls
 let toolCallTimestamps = [];
@@ -75,6 +80,9 @@ const allRequiredScopes = scopesBase.concat([
     'document:documents:write', // Create and update documents
 ]);
 const main = async () => {
+    // Dynamic import: @modelcontextprotocol/ext-apps is ESM-only and can't be require()'d.
+    const dynamicImport = new Function('specifier', 'return import(specifier)');
+    const { registerAppTool, registerAppResource, RESOURCE_MIME_TYPE } = await dynamicImport('@modelcontextprotocol/ext-apps/server');
     console.error(`Initializing Dynatrace MCP Server v${(0, version_1.getPackageJsonVersion)()}...`);
     // Configure proxy from environment variables early in the startup process
     (0, proxy_config_1.configureProxyFromEnvironment)();
@@ -94,8 +102,10 @@ const main = async () => {
         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
     }
+    // Parse environment information for telemetry
+    const environmentInfo = (0, environment_url_parser_1.parseEnvironmentUrl)(dtEnvironment);
     // Initialize usage tracking
-    const telemetry = (0, telemetry_openkit_1.createTelemetry)();
+    const telemetry = (0, telemetry_openkit_1.createTelemetry)(environmentInfo);
     await telemetry.trackMcpServerStart();
     // Create a shutdown handler that takes shutdown operations as parameters
     const shutdownHandler = (...shutdownOps) => {
@@ -178,9 +188,9 @@ const main = async () => {
     }
     // 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, title, description, paramsSchema, annotations, cb) => {
-        const wrappedCb = async (args) => {
+    // Wraps a string-returning tool callback with rate limiting, telemetry, and error handling
+    const wrapToolCallback = (name, cb) => {
+        return async (args, _extra) => {
             // Capture starttime for telemetry and rate limiting
             const startTime = Date.now();
             /**
@@ -207,9 +217,16 @@ const main = async () => {
                 // call the tool
                 const response = await cb(args);
                 toolCallSuccessful = true;
-                return {
-                    content: [{ type: 'text', text: response }],
+                // Support callbacks that return either a plain string or { text, _meta }
+                const text = typeof response === 'string' ? response : response.text;
+                const _meta = typeof response === 'string' ? undefined : response._meta;
+                const result = {
+                    content: [{ type: 'text', text }],
                 };
+                if (_meta) {
+                    result._meta = _meta;
+                }
+                return result;
             }
             catch (error) {
                 // Track error
@@ -236,12 +253,15 @@ const main = async () => {
                     .catch((e) => console.warn('Failed to track tool usage:', e));
             }
         };
+    };
+    // quick abstraction/wrapper to make it easier for tools to reply text instead of JSON
+    const tool = (name, title, description, paramsSchema, annotations, cb) => {
         server.registerTool(name, {
             title: title,
             description: description,
             inputSchema: zod_1.z.object(paramsSchema),
             annotations: annotations,
-        }, (args) => wrappedCb(args));
+        }, (args) => wrapToolCallback(name, cb)(args));
     };
     /**
      * Helper function to request human approval for potentially sensitive operations
@@ -420,13 +440,13 @@ const main = async () => {
             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 += `- 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()} == toSmartscapeId("${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' +
+                    '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> == toSmartscapeId(<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;
@@ -495,26 +515,39 @@ const main = async () => {
         }
         return resp;
     });
-    tool('execute_dql', '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, 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, recordLimit = 100, recordSizeLimitMB = 1 }) => {
+    // MCP App: Define the resource URI for the execute_dql interactive UI
+    // The ui:// scheme tells hosts this is an MCP App resource.
+    const executeDqlResourceUri = 'ui://execute-dql/execute-dql.html';
+    // Register the execute_dql tool with MCP App UI support.
+    registerAppTool(server, 'execute_dql', {
+        title: 'Execute DQL',
+        description: '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\\""',
+        inputSchema: {
+            dqlStatement: zod_1.z
+                .string()
+                .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)'),
+        },
+        annotations: {
+            // 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,
+        },
+        _meta: {
+            // MCP App
+            ui: { resourceUri: executeDqlResourceUri },
+        },
+    }, wrapToolCallback('execute_dql', 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
@@ -578,7 +611,25 @@ const main = async () => {
         }
         result += `\n📋 **Query Results**: (${response.records?.length || 0} records):\n\n`;
         result += `\`\`\`json\n${JSON.stringify(response.records, null, 2)}\n\`\`\``;
+        // Include field type definitions for chart rendering in the UI
+        if (response.types && response.types.length > 0) {
+            result += `\n\n📊 **Field Types**:\n\n`;
+            result += `\`\`\`json:types\n${JSON.stringify(response.types)}\n\`\`\``;
+        }
+        // Include analysisTimeframe metadata for chart rendering in the UI.
+        // This is needed when timeseries results lack explicit timeframe/interval
+        // columns (e.g. timeseries queries with fieldsRemove or custom projections).
+        if (response.metadata?.grail?.analysisTimeframe) {
+            result += `\n\n\`\`\`json:analysisTimeframe\n${JSON.stringify(response.metadata.grail.analysisTimeframe)}\n\`\`\``;
+        }
         return result;
+    }));
+    // MCP App: Register the HTML resource for the execute_dql interactive UI (MCP App)
+    registerAppResource(server, 'DQL Results Viewer', executeDqlResourceUri, {}, async () => {
+        const html = (0, node_fs_1.readFileSync)((0, node_path_1.join)(__dirname, 'ui', 'execute-dql', 'index.html'), 'utf-8');
+        return {
+            contents: [{ uri: executeDqlResourceUri, mimeType: RESOURCE_MIME_TYPE, text: html }],
+        };
     });
     tool('generate_dql_from_natural_language', 'Generate DQL from Natural Language', 'Convert natural language queries to Dynatrace Query Language (DQL) using Davis CoPilot AI. You can ask for problem events, security issues, logs, metrics, spans, and custom data.', {
         text: zod_1.z
@@ -1145,8 +1196,8 @@ You can now execute new Grail queries (DQL, etc.) again. If this happens more of
 main().catch(async (error) => {
     console.error('Fatal error in main():', error);
     try {
-        // report error in main
-        const telemetry = (0, telemetry_openkit_1.createTelemetry)();
+        // report error in main - use unknown environment info since we might not have parsed it yet
+        const telemetry = (0, telemetry_openkit_1.createTelemetry)({ environmentId: 'unknown', stage: 'unknown' });
         await telemetry.trackError(error, 'main_error');
         await telemetry.shutdown();
     }