@dynatrace-oss/dynatrace-mcp-server 0.5.0-rc.4 → 0.5.0

package/README.md

@@ -27,6 +27,20 @@ Bring real-time observability data directly into your development workflow.
 - Get more information about a monitored entity
 - Get Ownership of an entity
 
+## Costs
+
+**Important:** While this local MCP server is provided for free, using it to access data in Dynatrace Grail may incur additional costs based
+on your Dynatrace consumption model. This affects `execute_dql` tool and other capabilities that **query** Dynatrace Grail storage, and costs
+depend on the volume (GB scanned/billed).
+
+**Before using this MCP server extensively, please:**
+
+1. Review your current Dynatrace consumption model and pricing
+2. Understand the cost implications of the specific data you plan to query (logs, events, metrics) - see [Dynatrace Pricing and Rate Card](https://www.dynatrace.com/pricing/)
+3. Start with smaller timeframes (e.g., 12h-24h) and make use of [buckets](https://docs.dynatrace.com/docs/discover-dynatrace/platform/grail/data-model#built-in-grail-buckets) to reduce the cost impact
+
+**Note**: We will be providing a way to monitor Query Usage of the dynatrace-mcp-server in the future.
+
 ### AI-Powered Assistance (Preview)
 
 - **Natural Language to DQL** - Convert plain English queries to Dynatrace Query Language
@@ -554,6 +568,20 @@ Third, create a `.env` file in this repository (you can copy from `.env.template
 
 Finally, make changes to your code and compile it with `npm run build` or just run `npm run watch` and it auto-compiles.
 
+## Releasing
+
+When you are preparing for a release, you can use GitHub Copilot to guide you through the preparations.
+
+In Visual Studio Code, you can use `/release` in the chat with Copilot in Agent Mode, which will execute [release.prompt.md](.github/prompts/release.prompt.md).
+
+You may include additional information such as the version number. If not specified, you will be asked.
+
+This will
+
+- prepare the [changelog](CHANGELOG.md),
+- update the version number in [package.json](package.json),
+- commit the changes.
+
 ## Notes
 
 This product is not officially supported by Dynatrace.

package/dist/authentication/dynatrace-clients.js

@@ -3,7 +3,7 @@ Object.defineProperty(exports, "__esModule", { value: true });
 exports.createDtHttpClient = void 0;
 const http_client_1 = require("@dynatrace-sdk/http-client");
 const dt_app_1 = require("dt-app");
-const package_json_1 = require("../../package.json");
+const user_agent_1 = require("../utils/user-agent");
 /**
  * Uses the provided oauth Client ID and Secret and requests a token via client-credentials flow
  * @param clientId - OAuth Client ID for Dynatrace
@@ -60,7 +60,7 @@ const createBearerTokenHttpClient = async (environmentUrl, dtPlatformToken) => {
         baseUrl: environmentUrl,
         defaultHeaders: {
             'Authorization': `Bearer ${dtPlatformToken}`,
-            'User-Agent': `dynatrace-mcp-server/v${package_json_1.version} (${process.platform}-${process.arch})`,
+            'User-Agent': (0, user_agent_1.getUserAgent)(),
         },
     });
 };

package/dist/authentication/dynatrace-clients.test.js

@@ -62,7 +62,7 @@ describe('dynatrace-clients', () => {
                     baseUrl: environmentUrl,
                     defaultHeaders: {
                         'Authorization': 'Bearer test-access-token',
-                        'User-Agent': 'dynatrace-mcp-server/v1.0.0-test (linux-x64)',
+                        'User-Agent': expect.stringMatching(/^dynatrace-mcp-server\/v1\.0\.0-test \(\w+-\w+\)$/),
                     },
                 });
                 expect(result).toBeInstanceOf(http_client_1.PlatformHttpClient);
@@ -131,7 +131,7 @@ describe('dynatrace-clients', () => {
                     baseUrl: environmentUrl,
                     defaultHeaders: {
                         'Authorization': `Bearer ${dtPlatformToken}`,
-                        'User-Agent': 'dynatrace-mcp-server/v1.0.0-test (linux-x64)',
+                        'User-Agent': expect.stringMatching(/^dynatrace-mcp-server\/v1\.0\.0-test \(\w+-\w+\)$/),
                     },
                 });
                 expect(result).toBeInstanceOf(http_client_1.PlatformHttpClient);

package/dist/capabilities/execute-dql.js

@@ -2,6 +2,7 @@
 Object.defineProperty(exports, "__esModule", { value: true });
 exports.executeDql = exports.verifyDqlStatement = void 0;
 const client_query_1 = require("@dynatrace-sdk/client-query");
+const user_agent_1 = require("../utils/user-agent");
 const verifyDqlStatement = async (dtClient, dqlStatement) => {
     const queryAssistanceClient = new client_query_1.QueryAssistanceClient(dtClient);
     const response = await queryAssistanceClient.queryVerify({
@@ -22,7 +23,10 @@ exports.verifyDqlStatement = verifyDqlStatement;
  */
 const executeDql = async (dtClient, body) => {
     const queryExecutionClient = new client_query_1.QueryExecutionClient(dtClient);
-    const response = await queryExecutionClient.queryExecute({ body });
+    const response = await queryExecutionClient.queryExecute({
+        body,
+        dtClientContext: (0, user_agent_1.getUserAgent)(),
+    });
     if (response.result) {
         // return response result immediately
         return response.result.records;
@@ -36,6 +40,7 @@ const executeDql = async (dtClient, body) => {
             await new Promise((resolve) => setTimeout(resolve, 2000));
             pollResponse = await queryExecutionClient.queryPoll({
                 requestToken: response.requestToken,
+                dtClientContext: (0, user_agent_1.getUserAgent)(),
             });
             // done - let's return it
             if (pollResponse.result) {

package/dist/index.js

@@ -17,7 +17,6 @@ const list_vulnerabilities_1 = require("./capabilities/list-vulnerabilities");
 const list_problems_1 = require("./capabilities/list-problems");
 const get_monitored_entity_details_1 = require("./capabilities/get-monitored-entity-details");
 const get_ownership_information_1 = require("./capabilities/get-ownership-information");
-const get_logs_for_entity_1 = require("./capabilities/get-logs-for-entity");
 const get_events_for_cluster_1 = require("./capabilities/get-events-for-cluster");
 const create_workflow_for_problem_notification_1 = require("./capabilities/create-workflow-for-problem-notification");
 const update_workflow_1 = require("./capabilities/update-workflow");
@@ -261,13 +260,6 @@ const main = async () => {
         const response = await (0, send_slack_message_1.sendSlackMessage)(dtClient, slackConnectionId, channel, message);
         return `Message sent to Slack channel: ${JSON.stringify(response)}`;
     });
-    tool('get_logs_for_entity', 'Get Logs for a monitored entity based on name of the entity on Dynatrace', {
-        entityName: zod_1.z.string().optional(),
-    }, async ({ entityName }) => {
-        const dtClient = await (0, dynatrace_clients_1.createDtHttpClient)(dtEnvironment, scopesBase.concat('storage:logs:read'), oauthClientId, oauthClientSecret, dtPlatformToken);
-        const logs = await (0, get_logs_for_entity_1.getLogsForEntity)(dtClient, entityName);
-        return `Logs:\n${JSON.stringify(logs?.map((logLine) => (logLine ? logLine.content : 'Empty log')))}`;
-    });
     tool('verify_dql', 'Verify a Dynatrace Query Language (DQL) statement on Dynatrace GRAIL before executing it. This step is recommended for DQL statements that have been dynamically created by non-expert tools. For statements coming from the `generate_dql_from_natural_language` tool as well as from documentation, this step can be omitted.', {
         dqlStatement: zod_1.z.string(),
     }, async ({ dqlStatement }) => {
@@ -288,9 +280,14 @@ 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. It\'s recommended to use "verify_dql" tool before you execute a DQL statement. A valid statement looks like this: "fetch [logs, spans, events] | filter <some-filter> | summarize count(), by:{some-fields}. Adapt filters for certain attributes: `traceId` could be `trace_id` or `trace.id`.', {
-        dqlStatement: zod_1.z.string(),
+    tool('execute_dql', 'Get Logs, Metrics, Spans or Events from Dynatrace GRAIL by executing a Dynatrace Query Language (DQL) statement. ' +
+        'You can also use "generate_dql_from_natural_language" to generate a DQL statement based on your request. ' +
+        'Note: For more information about available fields for filters and aggregation, 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] | filter <some-filter> | summarize count(), by:{some-fields}.", "timeseries { avg(<metric-name>), value.A = avg(<metric-name>, scalar: true) }")'),
     }, async ({ dqlStatement }) => {
+        // Create a HTTP Client that has all storage:*:read scopes
         const dtClient = await (0, dynatrace_clients_1.createDtHttpClient)(dtEnvironment, scopesBase.concat('storage:buckets:read', // Read all system data stored on Grail
         'storage:logs:read', // Read logs for reliability guardian validations
         'storage:metrics:read', // Read metrics for reliability guardian validations

package/dist/utils/user-agent.js

@@ -0,0 +1,12 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.getUserAgent = void 0;
+const package_json_1 = require("../../package.json");
+/**
+ * Generate a user agent string for Dynatrace MCP Server
+ * @returns User agent string in format: dynatrace-mcp-server/vX.X.X (platform-arch)
+ */
+const getUserAgent = () => {
+    return `dynatrace-mcp-server/v${package_json_1.version} (${process.platform}-${process.arch})`;
+};
+exports.getUserAgent = getUserAgent;

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@dynatrace-oss/dynatrace-mcp-server",
-  "version": "0.5.0-rc.4",
+  "version": "0.5.0",
   "description": "Model Context Protocol (MCP) server for Dynatrace",
   "keywords": [
     "Dynatrace",
@@ -52,7 +52,7 @@
     "@dynatrace-sdk/shared-errors": "^1.0.0",
     "@modelcontextprotocol/sdk": "^1.8.0",
     "commander": "^14.0.0",
-    "dotenv": "^16.4.7",
+    "dotenv": "^17.2.1",
     "dt-app": "^0.148.1",
     "zod-to-json-schema": "^3.24.5"
   },

package/dist/capabilities/get-logs-for-entity.js

@@ -1,9 +0,0 @@
-"use strict";
-Object.defineProperty(exports, "__esModule", { value: true });
-exports.getLogsForEntity = void 0;
-const execute_dql_1 = require("./execute-dql");
-const getLogsForEntity = async (dtClient, entityId) => {
-    const dql = `fetch logs | filter dt.source_entity == "${entityId}"`;
-    return (0, execute_dql_1.executeDql)(dtClient, { query: dql });
-};
-exports.getLogsForEntity = getLogsForEntity;