refactor: improve code formatting and documentation comments with prettier

Author: rr-paras-patel

src/tools/hosts/index.ts

@@ -1,7 +1,7 @@
 /**
  * Central export file for the Datadog Hosts management tools.
  * Re-exports the tools and their handlers from the implementation file.
- * 
+ *
  * HOSTS_TOOLS: Array of tool schemas defining the available host management operations
  * HOSTS_HANDLERS: Object containing the implementation of each host management operation
  */

src/tools/hosts/schema.ts

@@ -8,44 +8,64 @@ import { z } from 'zod'
 /**
  * Schema for muting a host in Datadog.
  * Defines required and optional parameters for temporarily silencing a host's alerts.
- * 
+ *
  * @param hostname - Required. Identifies the host to be muted
  * @param message - Optional. Adds context about why the host is being muted
  * @param end - Optional. Unix timestamp defining when the mute should automatically expire
  * @param override - Optional. Controls whether to replace an existing mute's end time
  */
 export const MuteHostZodSchema = z.object({
   hostname: z.string().describe('The name of the host to mute'),
-  message: z.string().optional().describe('Message to associate with the muting of this host'),
-  end: z.number().int().optional().describe('POSIX timestamp for when the mute should end'),
-  override: z.boolean().optional().default(false).describe('If true and the host is already muted, replaces existing end time')
+  message: z
+    .string()
+    .optional()
+    .describe('Message to associate with the muting of this host'),
+  end: z
+    .number()
+    .int()
+    .optional()
+    .describe('POSIX timestamp for when the mute should end'),
+  override: z
+    .boolean()
+    .optional()
+    .default(false)
+    .describe(
+      'If true and the host is already muted, replaces existing end time',
+    ),
 })
 
 /**
  * Schema for unmuting a host in Datadog.
  * Defines parameters for re-enabling alerts for a previously muted host.
- * 
+ *
  * @param hostname - Required. Identifies the host to be unmuted
  */
 export const UnmuteHostZodSchema = z.object({
-  hostname: z.string().describe('The name of the host to unmute')
+  hostname: z.string().describe('The name of the host to unmute'),
 })
 
 /**
  * Schema for retrieving active host counts from Datadog.
  * Defines parameters for querying the number of reporting hosts within a time window.
- * 
+ *
  * @param from - Optional. Time window in seconds to check for host activity
  *               Defaults to 7200 seconds (2 hours)
  */
 export const GetActiveHostsCountZodSchema = z.object({
-  from: z.number().int().optional().default(7200).describe('Number of seconds from which you want to get total number of active hosts (defaults to 2h)'),
+  from: z
+    .number()
+    .int()
+    .optional()
+    .default(7200)
+    .describe(
+      'Number of seconds from which you want to get total number of active hosts (defaults to 2h)',
+    ),
 })
 
 /**
  * Schema for listing and filtering hosts in Datadog.
  * Defines comprehensive parameters for querying and filtering host information.
- * 
+ *
  * @param filter - Optional. Search string to filter hosts
  * @param sort_field - Optional. Field to sort results by
  * @param sort_dir - Optional. Sort direction ('asc' or 'desc')
@@ -60,8 +80,23 @@ export const ListHostsZodSchema = z.object({
   sort_field: z.string().optional().describe('Field to sort hosts by'),
   sort_dir: z.string().optional().describe('Sort direction (asc/desc)'),
   start: z.number().int().optional().describe('Starting offset for pagination'),
-  count: z.number().int().max(1000).optional().describe('Max number of hosts to return (max: 1000)'),
-  from: z.number().int().optional().describe('Search hosts from this UNIX timestamp'),
-  include_muted_hosts_data: z.boolean().optional().describe('Include muted hosts status and expiry'),
-  include_hosts_metadata: z.boolean().optional().describe('Include host metadata (version, platform, etc)'),
+  count: z
+    .number()
+    .int()
+    .max(1000)
+    .optional()
+    .describe('Max number of hosts to return (max: 1000)'),
+  from: z
+    .number()
+    .int()
+    .optional()
+    .describe('Search hosts from this UNIX timestamp'),
+  include_muted_hosts_data: z
+    .boolean()
+    .optional()
+    .describe('Include muted hosts status and expiry'),
+  include_hosts_metadata: z
+    .boolean()
+    .optional()
+    .describe('Include host metadata (version, platform, etc)'),
 })

src/tools/hosts/tool.ts

@@ -1,16 +1,25 @@
 import { ExtendedTool, ToolHandlers } from '../../utils/types'
 import { v1 } from '@datadog/datadog-api-client'
 import { createToolSchema } from '../../utils/tool'
-import { ListHostsZodSchema, GetActiveHostsCountZodSchema, MuteHostZodSchema, UnmuteHostZodSchema } from './schema'
+import {
+  ListHostsZodSchema,
+  GetActiveHostsCountZodSchema,
+  MuteHostZodSchema,
+  UnmuteHostZodSchema,
+} from './schema'
 import { datadogConfig } from '../../utils/datadog'
 
 /**
- * This module implements Datadog host management tools for muting, unmuting, 
+ * This module implements Datadog host management tools for muting, unmuting,
  * and retrieving host information using the Datadog API client.
  */
 
 /** Available host management tool names */
-type HostsToolName = 'list_hosts' | 'get_active_hosts_count' | 'mute_host' | 'unmute_host'
+type HostsToolName =
+  | 'list_hosts'
+  | 'get_active_hosts_count'
+  | 'mute_host'
+  | 'unmute_host'
 /** Extended tool type with host-specific operations */
 type HostsTool = ExtendedTool<HostsToolName>
 
@@ -19,11 +28,7 @@ type HostsTool = ExtendedTool<HostsToolName>
  * Each tool is created with a schema for input validation and includes a description.
  */
 export const HOSTS_TOOLS: HostsTool[] = [
-  createToolSchema(
-    MuteHostZodSchema,
-    'mute_host',
-    'Mute a host in Datadog',
-  ),
+  createToolSchema(MuteHostZodSchema, 'mute_host', 'Mute a host in Datadog'),
   createToolSchema(
     UnmuteHostZodSchema,
     'unmute_host',
@@ -57,7 +62,9 @@ export const HOSTS_HANDLERS: HostsToolHandlers = {
    * Silences alerts and notifications for the host until unmuted or until the specified end time.
    */
   mute_host: async (request) => {
-    const { hostname, message, end, override } = MuteHostZodSchema.parse(request.params.arguments)
+    const { hostname, message, end, override } = MuteHostZodSchema.parse(
+      request.params.arguments,
+    )
 
     await API_INSTANCE.muteHost({
       hostName: hostname,
@@ -72,10 +79,14 @@ export const HOSTS_HANDLERS: HostsToolHandlers = {
       content: [
         {
           type: 'text',
-          text: JSON.stringify({
-            status: 'success',
-            message: `Host ${hostname} has been muted successfully${message ? ` with message: ${message}` : ''}${end ? ` until ${new Date(end * 1000).toISOString()}` : ''}`
-          }, null, 2),
+          text: JSON.stringify(
+            {
+              status: 'success',
+              message: `Host ${hostname} has been muted successfully${message ? ` with message: ${message}` : ''}${end ? ` until ${new Date(end * 1000).toISOString()}` : ''}`,
+            },
+            null,
+            2,
+          ),
         },
       ],
     }
@@ -96,10 +107,14 @@ export const HOSTS_HANDLERS: HostsToolHandlers = {
       content: [
         {
           type: 'text',
-          text: JSON.stringify({
-            status: 'success',
-            message: `Host ${hostname} has been unmuted successfully`
-          }, null, 2),
+          text: JSON.stringify(
+            {
+              status: 'success',
+              message: `Host ${hostname} has been unmuted successfully`,
+            },
+            null,
+            2,
+          ),
         },
       ],
     }
@@ -110,8 +125,10 @@ export const HOSTS_HANDLERS: HostsToolHandlers = {
    * Provides total counts of hosts that are reporting and operational.
    */
   get_active_hosts_count: async (request) => {
-    const { from } = GetActiveHostsCountZodSchema.parse(request.params.arguments)
-    
+    const { from } = GetActiveHostsCountZodSchema.parse(
+      request.params.arguments,
+    )
+
     const response = await API_INSTANCE.getHostTotals({
       from,
     })
@@ -120,10 +137,14 @@ export const HOSTS_HANDLERS: HostsToolHandlers = {
       content: [
         {
           type: 'text',
-          text: JSON.stringify({
-            total_active: response.totalActive || 0, // Total number of active hosts (UP and reporting) to Datadog
-            total_up: response.totalUp || 0          // Number of hosts that are UP and reporting to Datadog
-          }, null, 2),
+          text: JSON.stringify(
+            {
+              total_active: response.totalActive || 0, // Total number of active hosts (UP and reporting) to Datadog
+              total_up: response.totalUp || 0, // Number of hosts that are UP and reporting to Datadog
+            },
+            null,
+            2,
+          ),
         },
       ],
     }