Adding comments

Author: swapnil-nagar

src/app.ts

@@ -146,6 +146,13 @@ export function webPubSub(name: string, options: WebPubSubFunctionOptions): void
     generic(name, convertToGenericOptions(options, trigger.webPubSub));
 }
 
+/**
+ * Registers an MCP Tool function in your app.
+ * This function is triggered by MCP Tool events and allows you to define the behavior of the function.
+ *
+ * @param name - The name of the function. This must be unique within your app and is primarily used for tracking purposes.
+ * @param options - Configuration options for the MCP Tool function, including the handler and trigger-specific settings.
+ */
 export function mcpTool(name: string, options: McpToolFunctionOptions): void {
     generic(name, convertToGenericOptions(options, trigger.mcpTool));
 }

src/trigger.ts

@@ -128,6 +128,13 @@ export function webPubSub(options: WebPubSubTriggerOptions): WebPubSubTrigger {
     });
 }
 
+/**
+ * Creates an MCP Tool trigger configuration.
+ * This function is used to define an MCP Tool trigger for an Azure Function.
+ *
+ * @param options - The configuration options for the MCP Tool trigger, including tool-specific metadata.
+ * @returns An MCP Tool trigger object with the specified configuration.
+ */
 export function mcpTool(options: McpToolTriggerOptions): McpToolTrigger {
     return addTriggerBindingName({
         ...options,

types/mcpTool.d.ts

@@ -4,28 +4,57 @@
 import { FunctionOptions, FunctionResult, FunctionTrigger } from './index';
 import { InvocationContext } from './InvocationContext';
 
+/**
+ * A handler function for MCP Tool triggers.
+ *
+ * @param messages - The messages or data received by the trigger.
+ * @param context - The invocation context for the function.
+ * @returns A result that can be a promise or a synchronous value.
+ */
 export type McpToolTriggerHandler = (messages: unknown, context: InvocationContext) => FunctionResult;
 
+/**
+ * Configuration options for an MCP Tool function.
+ * This includes trigger-specific options and general function options.
+ */
 export interface McpToolFunctionOptions extends McpToolTriggerOptions, Partial<FunctionOptions> {
+    /**
+     * The handler function to execute when the trigger is invoked.
+     */
     handler: McpToolTriggerHandler;
 
+    /**
+     * The trigger configuration for the MCP Tool.
+     */
     trigger?: McpToolTrigger;
 }
 
+/**
+ * Configuration options for an MCP Tool trigger.
+ * These options define the behavior and metadata for the trigger.
+ */
 export interface McpToolTriggerOptions {
     /**
-     * An app setting (or environment variable) with the service bus connection string
+     * The name of the tool associated with the trigger.
+     * This is typically an app setting or environment variable.
      */
     toolName: string;
 
     /**
-     * An app setting (or environment variable) with the service bus connection string
+     * A description of the tool or trigger.
+     * This provides additional context about the trigger's purpose.
      */
     description: string;
 
     /**
-     * A dictionary of arguments associated with the trigger.
+     * Additional properties or metadata for the tool.
+     * This is a dictionary of key-value pairs that can be used to configure the trigger.
      */
     toolProperties?: Record<string, unknown>;
 }
+
+/**
+ * Represents an MCP Tool trigger, combining base function trigger options
+ * with MCP Tool-specific trigger options.
+ */
 export type McpToolTrigger = FunctionTrigger & McpToolTriggerOptions;

types/trigger.d.ts

@@ -92,7 +92,7 @@ export function mySql(options: MySqlTriggerOptions): MySqlTrigger;
 export function webPubSub(options: WebPubSubTriggerOptions): WebPubSubTrigger;
 
 /**
- * [Link to docs and examples](https://docs.microsoft.com/azure/azure-functions/functions-bindings-web-pubsub-trigger?pivots=programming-language-javascript)
+ * [Link to docs and examples](//TODO Add link to docs and examples)
  */
 export function mcpTool(options: McpToolFunctionOptions): McpToolTrigger;