Update lib/mcp/server.js

Co-authored-by: Copilot <[email protected]>

Author: elasticdotventures

lib/mcp/server.js

@@ -803,6 +803,41 @@ function registerResources() {
   );
 }
 
+/**
+ * Starts the PM2 MCP server, exposing PM2 controls and state as Model Context Protocol resources.
+ *
+ * @param {Object} [options={}] - Configuration options for the MCP server.
+ * @param {'http'|'stdio'} [options.transportType='http'] - The transport type to use ('http' or 'stdio').
+ * @param {number} [options.port=0] - The port to listen on (for HTTP transport).
+ * @param {string} [options.host='127.0.0.1'] - The host to bind to (for HTTP transport).
+ * @param {string} [options.path] - The path for UNIX socket (for HTTP transport).
+ * @param {Object} [options.env] - Environment variables to set (merged into process.env).
+ * @param {boolean} [options.attachProcessHandlers=true] - Whether to register process signal handlers.
+ * @param {...any} [options.other] - Other options passed to the transport/server.
+ *
+ * @returns {Promise<Object>} Resolves to an object containing:
+ *   - {McpServer} server: The MCP server instance.
+ *   - {Object} transport: The transport instance (HTTP or stdio).
+ *   - {http.Server|null} httpServer: The HTTP server instance (if applicable).
+ *   - {Object} address: The address information for the server.
+ *
+ * @example
+ * // Start MCP server with default options
+ * const { server, transport, httpServer, address } = await startMcpServer();
+ *
+ * // Start MCP server on custom port
+ * const { server } = await startMcpServer({ port: 8080 });
+ *
+ * // Start MCP server with custom environment variables
+ * await startMcpServer({ env: { PM2_HOME: '/custom/path' } });
+ *
+ * @sideEffects
+ * - Modifies process.env if options.env is provided.
+ * - May register process signal handlers if options.attachProcessHandlers is true.
+ * - Starts network listeners (HTTP or stdio) as specified.
+ *
+ * @throws {Error} If the server fails to start or required resources are unavailable.
+ */
 async function startMcpServer(options = {}) {
   const { transport, httpServer, address } = createTransport(options);