feat(cli): add more details for arguments mcp description

GH-0

Author: Akshat Dubey

packages/cli/README.md

@@ -21,7 +21,7 @@ $ npm install -g @sourceloop/cli
 $ sl COMMAND
 running command...
 $ sl (-v|--version|version)
-@sourceloop/cli/10.0.0 darwin-arm64 node-v20.19.2
+@sourceloop/cli/10.0.0 linux-x64 node-v20.19.2
 $ sl --help [COMMAND]
 USAGE
   $ sl COMMAND
@@ -135,6 +135,16 @@ USAGE
 
 OPTIONS
   --help  show manual pages
+
+DESCRIPTION
+  Command that runs an MCP server for the sourceloop CLI, this is not supposed to be run directly, but rather used by
+  the MCP client to interact with the CLI commands.
+    You can use it using the following MCP server configuration:
+      "sourceloop": {
+        "command": "npx",
+        "args": ["@sourceloop/cli", "mcp"],
+        "timeout": 300
+      }
 ```
 
 _See code: [src/commands/mcp.ts](https://github.com/sourcefuse/loopback4-microservice-catalog/blob/v10.0.0/src/commands/mcp.ts)_

packages/cli/src/commands/cdk.ts

@@ -18,6 +18,7 @@ export class Cdk extends Base<CdkOptions> {
     Use this command to add arc-cdk to your project.
     The arc-cdk is a library that provides a set of tools and utilities to help you build and deploy your applications on AWS using the AWS Cloud Development Kit (CDK).
     It provides a set of constructs that can be used to build and deploy your applications on AWS using the AWS CDK.
+    Refer existing service if any for discovering the parameters not provided by the user, or ask the user directly
     `;
   static readonly flags = {
     help: flags.boolean({

packages/cli/src/commands/extension.ts

@@ -17,6 +17,8 @@ export class Extension extends Base<ExtensionOptions> {
     It can also be used to create reusable components that can be shared across multiple services or facades.
     The package will be created in the packages folder of the monorepo.
     You can use 'npm install @local/<package-name>' to install the package in other modules of the monorepo.
+    You can not update existing packages using this.
+    Refer existing packages if any for discovering the parameters not provided by the user, or ask the user directly
     `;
 
   static readonly mcpFlags = {

packages/cli/src/commands/mcp.ts

@@ -36,8 +36,15 @@ export class Mcp extends Base<{}> {
       this.commands = [Cdk, Extension, Microservice, Scaffold, Update];
     }
   }
-  static readonly description =
-    'Command that runs an MCP server for the sourceloop CLI, this is not supposed to be run directly, but rather used by the MCP client to interact with the CLI commands.';
+  static readonly description = `
+  Command that runs an MCP server for the sourceloop CLI, this is not supposed to be run directly, but rather used by the MCP client to interact with the CLI commands. 
+  You can use it using the following MCP server configuration:
+    "sourceloop": {
+      "command": "npx",
+      "args": ["@sourceloop/cli", "mcp"],
+      "timeout": 300
+    }
+    `;
 
   static readonly flags = {
     help: flags.boolean({
@@ -152,17 +159,20 @@ export class Mcp extends Base<{}> {
     switch (true) {
       case flag.type === 'boolean':
         option = z.boolean().optional();
+        description += ` (ask user for this value if not provided)`;
         option = option.default((flag.default as boolean) ?? false);
         break;
       case this._isOptionFlag(flag) && flag.options !== undefined: {
+        description += ` (ask user to provide an option if not provided when required, list the options as well)`;
         // typescript is not able to infer type
         const typedFlag = flag as IOptionFlag<T>;
         option = z.enum(typedFlag.options as [string, ...string[]]);
         description += ` (options: ${typedFlag.options?.join(', ')})`;
         break;
       }
       case this._isOptionFlag(flag) && flag.options === undefined:
-        option = z.string();
+        description += ` (ask user for this value if not provided)`;
+        option = z.string().optional();
         break;
       default:
         throw new Error(

packages/cli/src/commands/microservice.ts

@@ -17,7 +17,9 @@ export class Microservice extends Base<MicroserviceOptions> {
     The generated microservice can be used as a standalone service or as a facade in the monorepo.
     It can also generate migrations for the same microservice.
     The microservice will be created in the services or facades folder of the monorepo depending on the options passed.
-    It can also generate datasource and import migrations from the ARC services code.`;
+    It can also generate datasource and import migrations from the ARC services code. It can not update existing services or facades, 
+    for example, you can not run it again just with migration option as it would fail, saying the service already exists.
+    Refer existing service if any for discovering the parameters not provided by the user, or ask the user directly`;
   static readonly mcpFlags = {
     workingDir: flags.string({
       name: 'workingDir',