@aashari/boilerplate-mcp-server 1.6.0 → 1.8.0

package/CHANGELOG.md

@@ -1,3 +1,17 @@
+# [1.8.0](https://github.com/aashari/boilerplate-mcp-server/compare/v1.7.0...v1.8.0) (2025-05-18)
+
+
+### Features
+
+* refactor ControllerResponse to only include content field ([68118c7](https://github.com/aashari/boilerplate-mcp-server/commit/68118c75e4fcbe759140807a8d65e583e85b9535))
+
+# [1.7.0](https://github.com/aashari/boilerplate-mcp-server/compare/v1.6.0...v1.7.0) (2025-05-17)
+
+
+### Features
+
+* improve ip_get_details tool description and CLI usability with short options ([895feeb](https://github.com/aashari/boilerplate-mcp-server/commit/895feeb7ef23252ba32023cde658feaa9fd382d8))
+
 # [1.6.0](https://github.com/aashari/boilerplate-mcp-server/compare/v1.5.10...v1.6.0) (2025-05-15)
 
 

package/dist/cli/ipaddress.cli.js

@@ -18,7 +18,7 @@ function register(program) {
         .command('get-ip-details')
         .description('Gets geolocation and network details about an IP address or the current device.')
         .argument('[ipAddress]', 'IP address to lookup (omit for current IP)')
-        .option('--include-extended-data', 'Include extended data (ASN, host, org). Requires API token.')
+        .option('-e, --include-extended-data', 'Include extended data (ASN, host, org). Requires API token.')
         .option('--no-use-https', // commander creates a 'useHttps' boolean, defaulting to true
     'Use HTTP instead of HTTPS for the API call.')
         .action(async (ipAddress, options) => {

package/dist/tools/ipaddress.tool.js

@@ -35,14 +35,14 @@ async function handleGetIpDetails(args) {
         // Destructure options from the combined args
         const { ipAddress, ...controllerOptions } = args;
         // Call the controller with the ipAddress and the options object
-        const message = await ipaddress_controller_js_1.default.get(ipAddress, controllerOptions);
-        methodLogger.debug(`Got the response from the controller`, message);
+        const result = await ipaddress_controller_js_1.default.get(ipAddress, controllerOptions);
+        methodLogger.debug(`Got the response from the controller`, result);
         // Format the response for the MCP tool
         return {
             content: [
                 {
                     type: 'text',
-                    text: message.content,
+                    text: result.content,
                 },
             ],
         };
@@ -61,7 +61,7 @@ async function handleGetIpDetails(args) {
 function registerTools(server) {
     const methodLogger = logger_util_js_1.Logger.forContext('tools/ipaddress.tool.ts', 'registerTools');
     methodLogger.debug(`Registering IP address tools...`);
-    server.tool('ip_get_details', `Retrieves geolocation and network details for a public IP address (\`ipAddress\`). Falls back to the server's current public IP if omitted. Fetches country, city, coordinates, ISP, etc. Optionally includes extended data (\`includeExtendedData\`) like ASN, mobile/proxy/hosting detection. **Note:** Does not work for private IPs. Relies on ip-api.com. Use \`useHttps\` for paid tier.`, GetIpDetailsToolSchema.shape, // Use the combined schema for validation
+    server.tool('ip_get_details', `Retrieves detailed geolocation and network information for a public IP address (\`ipAddress\`). If no IP is provided, automatically uses the server's current public IP. Returns comprehensive location data including country, region, city, coordinates, timezone, and network details like ISP and organization. Use \`includeExtendedData\` to get additional information such as ASN, mobile/proxy detection (requires API token). **Note:** Cannot lookup private IPs (e.g., 192.168.x.x, 10.x.x.x). Powered by ip-api.com. Enable \`useHttps\` for secure connections (required for paid tier).`, GetIpDetailsToolSchema.shape, // Use the combined schema for validation
     handleGetIpDetails);
     methodLogger.debug('Successfully registered ip_get_details tool.');
 }

package/dist/types/common.types.d.ts

@@ -6,15 +6,15 @@
 /**
  * Common response structure for controller operations.
  * All controller methods should return this structure.
+ *
+ * All output, including pagination information and any additional metadata,
+ * is now consolidated into the content field as a single Markdown-formatted string.
  */
 export interface ControllerResponse {
     /**
      * Formatted content to be displayed to the user.
-     * Usually a Markdown-formatted string.
+     * A comprehensive Markdown-formatted string that includes all necessary information,
+     * including pagination details and any additional metadata.
      */
     content: string;
-    /**
-     * Optional metadata for any extra information associated with the response.
-     */
-    metadata?: Record<string, unknown>;
 }

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.6.0";
+export declare const VERSION = "1.8.0";
 /**
  * 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.6.0';
+exports.VERSION = '1.8.0';
 /**
  * Package name with scope
  * Used for initialization and identification

package/package.json

@@ -1,6 +1,6 @@
 {
 	"name": "@aashari/boilerplate-mcp-server",
-	"version": "1.6.0",
+	"version": "1.8.0",
 	"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",

package/package.json.bak

@@ -1,6 +1,6 @@
 {
 	"name": "@aashari/boilerplate-mcp-server",
-	"version": "1.5.10",
+	"version": "1.7.0",
 	"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",