feat: add monitors, logs, dashboards and metrics tools (#3)

Author: winor30

README.md

@@ -4,8 +4,8 @@ MCP server for the Datadog API, enabling incident management and more.
 
 ## Features
 
-- **Incident Management**: Enable listing and retrieving Datadog incidents through dedicated tools.
-- **Extensible Design**: Intended for future integrations with additional Datadog APIs.
+- **Observability Tools**: Provides a mechanism to leverage key Datadog monitoring features, such as incidents, monitors, logs, dashboards, and metrics, through the MCP server.
+- **Extensible Design**: Designed to easily integrate with additional Datadog APIs, allowing for seamless future feature expansion.
 
 ## Tools
 
@@ -24,7 +24,40 @@ MCP server for the Datadog API, enabling incident management and more.
      - `incident_id` (string): Incident ID to fetch details for.
    - **Returns**: Detailed incident information (title, status, timestamps, etc.).
 
-3. _(Planned)_: Additional tools for creating, updating, or resolving incidents, as well as for managing other Datadog resources (e.g., dashboards, monitors).
+3. `get_monitors`
+
+   - Fetch the status of Datadog monitors.
+   - **Inputs**:
+     - `groupStates` (optional array): States to filter (e.g., alert, warn, no data, ok).
+     - `name` (optional string): Filter by name.
+     - `tags` (optional array): Filter by tags.
+   - **Returns**: Monitors data and a summary of their statuses.
+
+4. `get_logs`
+
+   - Search and retrieve logs from Datadog.
+   - **Inputs**:
+     - `query` (string): Datadog logs query string.
+     - `from` (number): Start time in epoch seconds.
+     - `to` (number): End time in epoch seconds.
+     - `limit` (optional number): Maximum number of logs to return (defaults to 100).
+   - **Returns**: Array of matching logs.
+
+5. `list_dashboards`
+
+   - Get a list of dashboards from Datadog.
+   - **Inputs**:
+     - `name` (optional string): Filter dashboards by name.
+     - `tags` (optional array): Filter dashboards by tags.
+   - **Returns**: Array of dashboards with URL references.
+
+6. `get_metrics`
+   - Retrieve metrics data from Datadog.
+   - **Inputs**:
+     - `query` (string): Metrics query string.
+     - `from` (number): Start time in epoch seconds.
+     - `to` (number): End time in epoch seconds.
+   - **Returns**: Metrics data for the queried timeframe.
 
 ## Setup
 
@@ -122,8 +155,4 @@ Contributions are welcome! Feel free to open an issue or a pull request if you h
 
 ## License
 
-This project is licensed under the [MIT License](./LICENSE).
-
-```
-
-```
+This project is licensed under the [Apache License, Version 2.0](./LICENSE).

src/index.ts

@@ -15,6 +15,10 @@ import {
 } from '@modelcontextprotocol/sdk/types.js'
 import { log, mcpDatadogVersion } from './utils/helper'
 import { INCIDENT_HANDLERS, INCIDENT_TOOLS } from './tools/incident'
+import { METRICS_TOOLS, METRICS_HANDLERS } from './tools/metrics'
+import { LOGS_TOOLS, LOGS_HANDLERS } from './tools/logs'
+import { MONITORS_TOOLS, MONITORS_HANDLERS } from './tools/monitors'
+import { DASHBOARDS_TOOLS, DASHBOARDS_HANDLERS } from './tools/dashboards'
 import { ToolHandlers } from './utils/types'
 
 const server = new Server(
@@ -39,12 +43,22 @@ server.onerror = (error) => {
  */
 server.setRequestHandler(ListToolsRequestSchema, async () => {
   return {
-    tools: [...INCIDENT_TOOLS],
+    tools: [
+      ...INCIDENT_TOOLS,
+      ...METRICS_TOOLS,
+      ...LOGS_TOOLS,
+      ...MONITORS_TOOLS,
+      ...DASHBOARDS_TOOLS,
+    ],
   }
 })
 
 const TOOL_HANDLERS: ToolHandlers = {
   ...INCIDENT_HANDLERS,
+  ...METRICS_HANDLERS,
+  ...LOGS_HANDLERS,
+  ...MONITORS_HANDLERS,
+  ...DASHBOARDS_HANDLERS,
 }
 /**
  * Handler for invoking Datadog-related tools in the mcp-server-datadog.

src/tools/dashboards/index.ts

@@ -0,0 +1 @@
+export { DASHBOARDS_TOOLS, DASHBOARDS_HANDLERS } from './tool'

src/tools/dashboards/schema.ts

@@ -0,0 +1,6 @@
+import { z } from 'zod'
+
+export const ListDashboardsZodSchema = z.object({
+  name: z.string().optional().describe('Filter dashboards by name'),
+  tags: z.array(z.string()).optional().describe('Filter dashboards by tags'),
+})

src/tools/dashboards/tool.ts

@@ -0,0 +1,65 @@
+import { ExtendedTool, ToolHandlers } from '../../utils/types'
+import { v1 } from '@datadog/datadog-api-client'
+import { createToolSchema } from '../../utils/tool'
+import { ListDashboardsZodSchema } from './schema'
+import { datadogConfig } from '../../utils/datadog'
+
+type DashboardsToolName = 'list_dashboards'
+type DashboardsTool = ExtendedTool<DashboardsToolName>
+
+export const DASHBOARDS_TOOLS: DashboardsTool[] = [
+  createToolSchema(
+    ListDashboardsZodSchema,
+    'list_dashboards',
+    'Get list of dashboards from Datadog',
+  ),
+] as const
+
+const API_INSTANCE = new v1.DashboardsApi(datadogConfig)
+
+type DashboardsToolHandlers = ToolHandlers<DashboardsToolName>
+
+export const DASHBOARDS_HANDLERS: DashboardsToolHandlers = {
+  list_dashboards: async (request) => {
+    const { name, tags } = ListDashboardsZodSchema.parse(
+      request.params.arguments,
+    )
+
+    const response = await API_INSTANCE.listDashboards({
+      filterShared: false,
+    })
+
+    if (!response.dashboards) {
+      throw new Error('No dashboards data returned')
+    }
+
+    // Filter dashboards based on name and tags if provided
+    let filteredDashboards = response.dashboards
+    if (name) {
+      const searchTerm = name.toLowerCase()
+      filteredDashboards = filteredDashboards.filter((dashboard) =>
+        dashboard.title?.toLowerCase().includes(searchTerm),
+      )
+    }
+    if (tags && tags.length > 0) {
+      filteredDashboards = filteredDashboards.filter((dashboard) => {
+        const dashboardTags = dashboard.description?.split(',') || []
+        return tags.every((tag) => dashboardTags.includes(tag))
+      })
+    }
+
+    const dashboards = filteredDashboards.map((dashboard) => ({
+      ...dashboard,
+      url: `https://app.datadoghq.com/dashboard/${dashboard.id}`,
+    }))
+
+    return {
+      content: [
+        {
+          type: 'text',
+          text: `Dashboards: ${JSON.stringify(dashboards)}`,
+        },
+      ],
+    }
+  },
+} as const

src/tools/incident/schema.ts

@@ -8,6 +8,3 @@ export const ListIncidentsZodSchema = z.object({
 export const GetIncidentZodSchema = z.object({
   incidentId: z.string().nonempty(),
 })
-
-export type ListIncidentsArgs = z.infer<typeof ListIncidentsZodSchema>
-export type GetIncidentArgs = z.infer<typeof GetIncidentZodSchema>

src/tools/incident/tool.ts

@@ -26,8 +26,10 @@ type IncidentToolHandlers = ToolHandlers<IncidentToolName>
 
 export const INCIDENT_HANDLERS: IncidentToolHandlers = {
   list_incidents: async (request) => {
-    const pageSize = Number(request.params.arguments?.pageSize) || 10
-    const pageOffset = Number(request.params.arguments?.pageOffset) || 0
+    const { pageSize, pageOffset } = ListIncidentsZodSchema.parse(
+      request.params.arguments,
+    )
+
     const res = await API_INSTANCE.listIncidents({
       pageSize: pageSize,
       pageOffset: pageOffset,
@@ -44,7 +46,7 @@ export const INCIDENT_HANDLERS: IncidentToolHandlers = {
     }
   },
   get_incident: async (request) => {
-    const incidentId = request.params.arguments?.incidentId as string
+    const { incidentId } = GetIncidentZodSchema.parse(request.params.arguments)
     const res = await API_INSTANCE.getIncident({
       incidentId: incidentId,
     })

src/tools/logs/index.ts

@@ -0,0 +1 @@
+export { LOGS_TOOLS, LOGS_HANDLERS } from './tool'

src/tools/logs/schema.ts

@@ -0,0 +1,12 @@
+import { z } from 'zod'
+
+export const GetLogsZodSchema = z.object({
+  query: z.string().default('').describe('Datadog logs query string'),
+  from: z.number().describe('Start time in epoch seconds'),
+  to: z.number().describe('End time in epoch seconds'),
+  limit: z
+    .number()
+    .optional()
+    .default(100)
+    .describe('Maximum number of logs to return. Default is 100.'),
+})

src/tools/logs/tool.ts

@@ -0,0 +1,56 @@
+import { ExtendedTool, ToolHandlers } from '../../utils/types'
+import { v2 } from '@datadog/datadog-api-client'
+import { createToolSchema } from '../../utils/tool'
+import { GetLogsZodSchema } from './schema'
+import { datadogConfig } from '../../utils/datadog'
+
+type LogsToolName = 'get_logs'
+type LogsTool = ExtendedTool<LogsToolName>
+
+export const LOGS_TOOLS: LogsTool[] = [
+  createToolSchema(
+    GetLogsZodSchema,
+    'get_logs',
+    'Search and retrieve logs from Datadog',
+  ),
+] as const
+
+const API_INSTANCE = new v2.LogsApi(datadogConfig)
+
+type LogsToolHandlers = ToolHandlers<LogsToolName>
+
+export const LOGS_HANDLERS: LogsToolHandlers = {
+  get_logs: async (request) => {
+    const { query, from, to, limit } = GetLogsZodSchema.parse(
+      request.params.arguments,
+    )
+
+    const response = await API_INSTANCE.listLogs({
+      body: {
+        filter: {
+          query,
+          // `from` and `to` are in epoch seconds, but the Datadog API expects milliseconds
+          from: `${from * 1000}`,
+          to: `${to * 1000}`,
+        },
+        page: {
+          limit,
+        },
+        sort: '-timestamp',
+      },
+    })
+
+    if (response.data == null) {
+      throw new Error('No logs data returned')
+    }
+
+    return {
+      content: [
+        {
+          type: 'text',
+          text: `Logs data: ${JSON.stringify(response.data)}`,
+        },
+      ],
+    }
+  },
+} as const

src/tools/metrics/index.ts

@@ -0,0 +1 @@
+export { METRICS_TOOLS, METRICS_HANDLERS } from './tool'

src/tools/metrics/schema.ts

@@ -0,0 +1,11 @@
+import { z } from 'zod'
+
+export const GetMetricsZodSchema = z.object({
+  from: z.number().describe('Start time in epoch seconds'),
+  to: z.number().describe('End time in epoch seconds'),
+  query: z
+    .string()
+    .describe('Datadog metrics query string. e.g. "avg:system.cpu.user{*}'),
+})
+
+export type GetMetricsArgs = z.infer<typeof GetMetricsZodSchema>

src/tools/metrics/tool.ts

@@ -0,0 +1,43 @@
+import { ExtendedTool, ToolHandlers } from '../../utils/types'
+import { v1 } from '@datadog/datadog-api-client'
+import { createToolSchema } from '../../utils/tool'
+import { GetMetricsZodSchema } from './schema'
+import { datadogConfig } from '../../utils/datadog'
+
+type MetricsToolName = 'get_metrics'
+type MetricsTool = ExtendedTool<MetricsToolName>
+
+export const METRICS_TOOLS: MetricsTool[] = [
+  createToolSchema(
+    GetMetricsZodSchema,
+    'get_metrics',
+    'Get metrics data from Datadog',
+  ),
+] as const
+
+const API_INSTANCE = new v1.MetricsApi(datadogConfig)
+
+type MetricsToolHandlers = ToolHandlers<MetricsToolName>
+
+export const METRICS_HANDLERS: MetricsToolHandlers = {
+  get_metrics: async (request) => {
+    const { from, to, query } = GetMetricsZodSchema.parse(
+      request.params.arguments,
+    )
+
+    const response = await API_INSTANCE.queryMetrics({
+      from,
+      to,
+      query,
+    })
+
+    return {
+      content: [
+        {
+          type: 'text',
+          text: `Metrics data: ${JSON.stringify({ response })}`,
+        },
+      ],
+    }
+  },
+} as const

src/tools/monitors/index.ts

@@ -0,0 +1 @@
+export { MONITORS_TOOLS, MONITORS_HANDLERS } from './tool'

src/tools/monitors/schema.ts

@@ -0,0 +1,10 @@
+import { z } from 'zod'
+
+export const GetMonitorsZodSchema = z.object({
+  groupStates: z
+    .array(z.enum(['alert', 'warn', 'no data', 'ok']))
+    .optional()
+    .describe('Filter monitors by their states'),
+  name: z.string().optional().describe('Filter monitors by name'),
+  tags: z.array(z.string()).optional().describe('Filter monitors by tags'),
+})