@aashari/boilerplate-mcp-server 1.10.2 → 1.10.3

package/CHANGELOG.md

@@ -1,3 +1,11 @@
+## [1.10.3](https://github.com/aashari/boilerplate-mcp-server/compare/v1.10.2...v1.10.3) (2025-05-21)
+
+
+### Bug Fixes
+
+* Refactor IP address controller to accept args as a single object ([acb7ea2](https://github.com/aashari/boilerplate-mcp-server/commit/acb7ea2a148e9673a4bf2aa703f8ca988dc05c93))
+* update dependencies ([02c42fa](https://github.com/aashari/boilerplate-mcp-server/commit/02c42fa6ef66be461444d1780b013860b455cbff))
+
 ## [1.10.2](https://github.com/aashari/boilerplate-mcp-server/compare/v1.10.1...v1.10.2) (2025-05-21)
 
 

package/dist/cli/ipaddress.cli.js

@@ -28,12 +28,13 @@ function register(program) {
                 ipAddress,
                 options,
             });
-            // Map CLI options to the controller options type (IpAddressToolArgsType)
-            const controllerOptions = {
+            // Create a single args object to pass to the controller
+            const args = {
+                ipAddress,
                 includeExtendedData: options.includeExtendedData || false,
                 useHttps: options.useHttps, // commander handles the default via --no-use-https
             };
-            const result = await ipaddress_controller_js_1.default.get(ipAddress, controllerOptions);
+            const result = await ipaddress_controller_js_1.default.get(args);
             console.log(result.content);
         }
         catch (error) {

package/dist/controllers/ipaddress.controller.d.ts

@@ -1,5 +1,4 @@
 import { ControllerResponse } from '../types/common.types.js';
-import { IpAddressToolArgsType } from '../tools/ipaddress.types.js';
 /**
  * @namespace IpAddressController
  * @description Controller responsible for handling IP address lookup logic.
@@ -11,12 +10,18 @@ import { IpAddressToolArgsType } from '../tools/ipaddress.types.js';
  * @description Fetches details for a specific IP address or the current device's IP.
  *              Handles mapping controller options (like includeExtendedData) to service parameters (fields).
  * @memberof IpAddressController
- * @param {string} [ipAddress] - Optional IP address to look up. If omitted, the service will fetch the current device's public IP.
- * @param {IpAddressToolArgsType} [options={}] - Optional configuration for the request, such as `includeExtendedData` and `useHttps`.
+ * @param {Object} args - Arguments containing ipAddress and options
+ * @param {string} [args.ipAddress] - Optional IP address to look up. If omitted, the service will fetch the current device's public IP.
+ * @param {boolean} [args.includeExtendedData=false] - Whether to include extended data fields requiring an API token
+ * @param {boolean} [args.useHttps=true] - Whether to use HTTPS for the API request
  * @returns {Promise<ControllerResponse>} A promise that resolves to the standard controller response containing the formatted IP details in Markdown.
  * @throws {McpError} Throws an McpError (handled by `handleControllerError`) if the service call fails or returns an error.
  */
-declare function get(ipAddress?: string, options?: IpAddressToolArgsType): Promise<ControllerResponse>;
+declare function get(args?: {
+    ipAddress?: string;
+    includeExtendedData?: boolean;
+    useHttps?: boolean;
+}): Promise<ControllerResponse>;
 declare const _default: {
     get: typeof get;
 };

package/dist/controllers/ipaddress.controller.js

@@ -21,57 +21,59 @@ const error_handler_util_js_2 = require("../utils/error-handler.util.js");
  * @description Fetches details for a specific IP address or the current device's IP.
  *              Handles mapping controller options (like includeExtendedData) to service parameters (fields).
  * @memberof IpAddressController
- * @param {string} [ipAddress] - Optional IP address to look up. If omitted, the service will fetch the current device's public IP.
- * @param {IpAddressToolArgsType} [options={}] - Optional configuration for the request, such as `includeExtendedData` and `useHttps`.
+ * @param {Object} args - Arguments containing ipAddress and options
+ * @param {string} [args.ipAddress] - Optional IP address to look up. If omitted, the service will fetch the current device's public IP.
+ * @param {boolean} [args.includeExtendedData=false] - Whether to include extended data fields requiring an API token
+ * @param {boolean} [args.useHttps=true] - Whether to use HTTPS for the API request
  * @returns {Promise<ControllerResponse>} A promise that resolves to the standard controller response containing the formatted IP details in Markdown.
  * @throws {McpError} Throws an McpError (handled by `handleControllerError`) if the service call fails or returns an error.
  */
-async function get(ipAddress, options = {
-    includeExtendedData: false,
-    useHttps: true,
-}) {
+async function get(args = {}) {
     const methodLogger = logger_util_js_1.Logger.forContext('controllers/ipaddress.controller.ts', 'get');
-    methodLogger.debug(`Getting IP address details for ${ipAddress || 'current device'}...`);
+    methodLogger.debug(`Getting IP address details for ${args.ipAddress || 'current device'}...`);
     try {
         // Detect if we're running in a test environment
         const isTestEnvironment = process.env.NODE_ENV === 'test' ||
             process.env.JEST_WORKER_ID !== undefined;
-        // Make a copy of options to avoid modifying the original
-        const safeOptions = { ...options };
+        // Apply defaults
+        const options = {
+            includeExtendedData: args.includeExtendedData ?? false,
+            useHttps: args.useHttps ?? true,
+        };
         // Special handling for test environments
         if (isTestEnvironment) {
             methodLogger.debug('Running in test environment');
             // Force these settings for consistent test behavior
-            safeOptions.includeExtendedData = false;
-            safeOptions.useHttps = false;
+            options.includeExtendedData = false;
+            options.useHttps = false;
         }
         // For non-test environments, check API token
         else {
             const hasApiToken = Boolean(config_util_js_1.config.get('IPAPI_API_TOKEN'));
-            if (safeOptions.includeExtendedData && !hasApiToken) {
+            if (options.includeExtendedData && !hasApiToken) {
                 methodLogger.warn('Extended data requested but no API token found. Falling back to basic data.');
-                safeOptions.includeExtendedData = false;
+                options.includeExtendedData = false;
             }
         }
         // Service options
         const serviceOptions = {
-            useHttps: safeOptions.useHttps,
+            useHttps: options.useHttps,
             // Map includeExtendedData to the 'fields' expected by the service
             // Only send fields parameter if explicitly requesting extended data
-            fields: safeOptions.includeExtendedData
+            fields: options.includeExtendedData
                 ? getAllIpApiFields()
                 : undefined,
         };
-        methodLogger.debug(`Getting IP details for ${ipAddress || 'current IP'}`, {
-            ipAddress,
-            originalOptions: options,
-            safeOptions,
+        methodLogger.debug(`Getting IP details for ${args.ipAddress || 'current IP'}`, {
+            ipAddress: args.ipAddress,
+            originalOptions: args,
+            options,
             serviceOptions,
             isTestEnvironment,
         });
         try {
             // Call the service with ipAddress and the mapped serviceOptions
-            const data = await vendor_ip_api_com_service_js_1.default.get(ipAddress, serviceOptions);
+            const data = await vendor_ip_api_com_service_js_1.default.get(args.ipAddress, serviceOptions);
             methodLogger.debug(`Got the response from the service`, data);
             const formattedContent = (0, ipaddress_formatter_js_1.formatIpDetails)(data);
             return { content: formattedContent };
@@ -85,7 +87,7 @@ async function get(ipAddress, options = {
                     error.message.includes('Access denied'))) {
                 methodLogger.warn('HTTPS request failed, falling back to HTTP');
                 // Try again with HTTP
-                const httpData = await vendor_ip_api_com_service_js_1.default.get(ipAddress, {
+                const httpData = await vendor_ip_api_com_service_js_1.default.get(args.ipAddress, {
                     ...serviceOptions,
                     useHttps: false,
                 });
@@ -98,7 +100,7 @@ async function get(ipAddress, options = {
         }
     }
     catch (error) {
-        throw (0, error_handler_util_js_1.handleControllerError)(error, (0, error_handler_util_js_2.buildErrorContext)('IP Address', 'get', 'controllers/ipaddress.controller.ts@get', ipAddress || 'current device', { options }));
+        throw (0, error_handler_util_js_1.handleControllerError)(error, (0, error_handler_util_js_2.buildErrorContext)('IP Address', 'get', 'controllers/ipaddress.controller.ts@get', args.ipAddress || 'current device', { args }));
     }
 }
 /** Helper to define all fields for extended data */

package/dist/resources/ipaddress.resource.js

@@ -27,7 +27,8 @@ function registerResources(server) {
             // Get everything after the ip:// protocol
             const ipAddress = uri.toString().replace(/^ip:\/\//, '');
             // Call the controller to get the IP details
-            const result = await ipaddress_controller_js_1.default.get(ipAddress || undefined, {
+            const result = await ipaddress_controller_js_1.default.get({
+                ipAddress: ipAddress || undefined,
                 includeExtendedData: false,
                 useHttps: true,
             });

package/dist/tools/ipaddress.tool.js

@@ -32,10 +32,8 @@ async function handleGetIpDetails(args) {
     const methodLogger = logger_util_js_1.Logger.forContext('tools/ipaddress.tool.ts', 'handleGetIpDetails');
     methodLogger.debug(`Getting IP address details for ${args.ipAddress || 'current IP'}...`, args);
     try {
-        // Destructure options from the combined args
-        const { ipAddress, ...controllerOptions } = args;
-        // Call the controller with the ipAddress and the options object
-        const result = await ipaddress_controller_js_1.default.get(ipAddress, controllerOptions);
+        // Pass args directly to the controller
+        const result = await ipaddress_controller_js_1.default.get(args);
         methodLogger.debug(`Got the response from the controller`, result);
         // Format the response for the MCP tool
         return {

package/dist/utils/constants.util.d.ts

@@ -8,7 +8,7 @@
  * Current application version
  * This should match the version in package.json
  */
-export declare const VERSION = "1.10.2";
+export declare const VERSION = "1.10.3";
 /**
  * Package name with scope
  * Used for initialization and identification

package/dist/utils/constants.util.js

@@ -11,7 +11,7 @@ exports.CLI_NAME = exports.PACKAGE_NAME = exports.VERSION = void 0;
  * Current application version
  * This should match the version in package.json
  */
-exports.VERSION = '1.10.2';
+exports.VERSION = '1.10.3';
 /**
  * Package name with scope
  * Used for initialization and identification

package/package.json

@@ -1,6 +1,6 @@
 {
 	"name": "@aashari/boilerplate-mcp-server",
-	"version": "1.10.2",
+	"version": "1.10.3",
 	"description": "TypeScript Model Context Protocol (MCP) server boilerplate providing IP lookup tools/resources. Includes CLI support and extensible structure for connecting AI systems (LLMs) to external data sources like ip-api.com. Ideal template for creating new MCP integrations via Node.js.",
 	"main": "dist/index.js",
 	"types": "dist/index.d.ts",
@@ -84,7 +84,7 @@
 		"@modelcontextprotocol/sdk": "^1.11.4",
 		"commander": "^14.0.0",
 		"dotenv": "^16.5.0",
-		"zod": "^3.25.13"
+		"zod": "^3.25.17"
 	},
 	"directories": {
 		"example": "examples"

package/package.json.bak

@@ -1,6 +1,6 @@
 {
 	"name": "@aashari/boilerplate-mcp-server",
-	"version": "1.10.1",
+	"version": "1.10.2",
 	"description": "TypeScript Model Context Protocol (MCP) server boilerplate providing IP lookup tools/resources. Includes CLI support and extensible structure for connecting AI systems (LLMs) to external data sources like ip-api.com. Ideal template for creating new MCP integrations via Node.js.",
 	"main": "dist/index.js",
 	"types": "dist/index.d.ts",
@@ -84,7 +84,7 @@
 		"@modelcontextprotocol/sdk": "^1.11.4",
 		"commander": "^14.0.0",
 		"dotenv": "^16.5.0",
-		"zod": "^3.25.13"
+		"zod": "^3.25.17"
 	},
 	"directories": {
 		"example": "examples"