@teambit/cli-mcp-server 0.0.12 → 0.0.14

package/README.docs.mdx

@@ -34,45 +34,64 @@ Options:
 - `-e, --extended`: Enable the full set of Bit CLI commands as MCP tools
 - `--consumer-project`: For non-Bit workspaces that only consume Bit component packages. Enables only "schema", "show", and "remote-search" tools and automatically adds the "--remote" flag to relevant commands.
 - `--include-only <commands>`: Specify a subset of commands to expose as MCP tools (comma-separated list)
-- `--include-additional <commands>`: Add specific commands to the default set (comma-separated list)
+- `--include-additional <commands>`: Add specific commands to the available tools (comma-separated list)
 - `--exclude <commands>`: Prevent specific commands from being exposed (comma-separated list)
 
-### Integrating with VS Code
+### Integrating with IDEs
 
-To use this MCP server in VS Code:
+The easiest way to integrate the MCP server with your IDE is to use the `setup` command:
 
-1. Open VS Code settings (JSON) by pressing `Ctrl + Shift + P` and typing `Preferences: Open Settings (JSON)`
-2. Add the following JSON block:
+```bash
+# Basic setup for VS Code (default)
+bit mcp-server setup
+```
 
-```json
-{
-  "mcp": {
-    "servers": {
-      "bit-cli": {
-        "command": "bit",
-        "args": ["mcp-server"]
-      }
-    }
-  }
-}
+This will automatically configure your VS Code settings to use the Bit MCP server. See the [Automatic Setup](#automatic-integration-setup) section below for more options.
+
+### Automatic Integration Setup
+
+The **recommended way** to integrate the MCP server with your IDE is using the `setup` command:
+
+```bash
+bit mcp-server setup [vscode|cursor|windsurf] [options]
 ```
 
-For extended mode with all commands available:
+This command automatically configures the MCP server settings in your chosen editor. If no editor is specified, it defaults to VS Code.
 
-```json
-{
-  "mcp": {
-    "servers": {
-      "bit-cli": {
-        "command": "bit",
-        "args": ["mcp-server", "--extended"]
-      }
-    }
-  }
-}
+#### Supported Editors
+
+- **VS Code**: `bit mcp-server setup vscode` (or just `bit mcp-server setup`)
+- **Cursor**: `bit mcp-server setup cursor`
+- **Windsurf**: `bit mcp-server setup windsurf`
+
+#### Configuration Options
+
+- `--global`: Apply configuration globally (user settings) instead of workspace settings
+- `--extended`: Configure with extended mode enabled
+- `--consumer-project`: Configure for consumer projects
+- `--include-only <commands>`: Specify subset of commands to expose
+- `--include-additional <commands>`: Add specific commands to the available tools
+- `--exclude <commands>`: Prevent specific commands from being exposed
+
+#### Examples
+
+```bash
+# Basic VS Code setup (workspace level)
+bit mcp-server setup
+
+# Global setup for Cursor with extended mode
+bit mcp-server setup cursor --global --extended
+
+# Setup for Windsurf with consumer project mode
+bit mcp-server setup windsurf --consumer-project
 ```
 
-For consumer projects that only use Bit component packages:
+#### Manual Configuration
+
+If you need to manually configure the settings, here's a basic example for VS Code:
+
+1. Open VS Code settings (JSON) by pressing `Ctrl + Shift + P` (or `Cmd + Shift + P` on macOS) and typing `Preferences: Open Settings (JSON)`
+2. Add the following configuration:
 
 ```json
 {
@@ -80,7 +99,7 @@ For consumer projects that only use Bit component packages:
     "servers": {
       "bit-cli": {
         "command": "bit",
-        "args": ["mcp-server", "--consumer-project"]
+        "args": ["mcp-server"]
       }
     }
   }
@@ -110,23 +129,19 @@ The Bit CLI MCP Server operates in three modes and provides several specialized
 
 ### Default Mode
 
-In default mode, the server exposes a minimal set of essential tools focused on component discovery and creation. This ensures optimal performance and safety:
+In default mode, the server exposes a minimal set of essential tools focused on core functionality. This ensures optimal performance and safety:
 
-- **Individual CLI Command Tools:**
+- **Always Available Tools:**
 
-  - `bit_create`: Generate components from templates
-  - `bit_schema`: Retrieve component API schema from workspace or remote scopes
   - `bit_remote_search`: Search for components in remote scopes
-
-- **Specialized Composite Tools:**
-
   - `bit_workspace_info`: Get comprehensive workspace information including status, components list, apps, templates, and dependency graph
   - `bit_component_details`: Get detailed information about a specific component including basic info and optionally its public API schema
-  - `bit_commands_info`: Get information about available Bit commands and their groups
-
-- **Generic Execution Tools:**
   - `bit_query`: Execute read-only Bit commands that safely inspect workspace and component state without making modifications
   - `bit_execute`: Execute any Bit command, including those that modify workspace or repository state (use with caution)
+  - `bit_commands_list`: Get all available Bit commands with descriptions and groups (for command discovery)
+  - `bit_command_help`: Get detailed help for a specific Bit command including syntax, arguments, flags, and usage examples
+
+> **Command Discovery vs. Command Help**: Use `bit_commands_list` to discover what commands are available in Bit, then use `bit_command_help` with a specific command name to get detailed usage information including arguments, flags, and examples.
 
 ### Consumer Project Mode (--consumer-project)
 
@@ -134,7 +149,6 @@ This mode is designed for applications or projects that are not Bit workspaces b
 
 - `bit_schema`: Retrieves component API schema from remote scopes (automatically adds `--remote` flag)
 - `bit_show`: Displays component information from remote scopes (automatically adds `--remote` flag)
-- `bit_remote_search`: Searches for components in remote scopes
 
 In this mode:
 
@@ -179,8 +193,8 @@ To customize the available tools beyond the default set or extended mode:
 # Include only specific tools
 bit mcp-server --include-only "status,show,tag,snap,import,export"
 
-# Add specific tools to the default set
-bit mcp-server --include-additional "build,lint,format"
+# Add specific tools to the available tools
+bit mcp-server --include-additional "build,lint,format,create,schema"
 
 # For consumer projects (non-Bit workspaces)
 bit mcp-server --consumer-project

package/dist/README.docs.mdx

@@ -34,45 +34,64 @@ Options:
 - `-e, --extended`: Enable the full set of Bit CLI commands as MCP tools
 - `--consumer-project`: For non-Bit workspaces that only consume Bit component packages. Enables only "schema", "show", and "remote-search" tools and automatically adds the "--remote" flag to relevant commands.
 - `--include-only <commands>`: Specify a subset of commands to expose as MCP tools (comma-separated list)
-- `--include-additional <commands>`: Add specific commands to the default set (comma-separated list)
+- `--include-additional <commands>`: Add specific commands to the available tools (comma-separated list)
 - `--exclude <commands>`: Prevent specific commands from being exposed (comma-separated list)
 
-### Integrating with VS Code
+### Integrating with IDEs
 
-To use this MCP server in VS Code:
+The easiest way to integrate the MCP server with your IDE is to use the `setup` command:
 
-1. Open VS Code settings (JSON) by pressing `Ctrl + Shift + P` and typing `Preferences: Open Settings (JSON)`
-2. Add the following JSON block:
+```bash
+# Basic setup for VS Code (default)
+bit mcp-server setup
+```
 
-```json
-{
-  "mcp": {
-    "servers": {
-      "bit-cli": {
-        "command": "bit",
-        "args": ["mcp-server"]
-      }
-    }
-  }
-}
+This will automatically configure your VS Code settings to use the Bit MCP server. See the [Automatic Setup](#automatic-integration-setup) section below for more options.
+
+### Automatic Integration Setup
+
+The **recommended way** to integrate the MCP server with your IDE is using the `setup` command:
+
+```bash
+bit mcp-server setup [vscode|cursor|windsurf] [options]
 ```
 
-For extended mode with all commands available:
+This command automatically configures the MCP server settings in your chosen editor. If no editor is specified, it defaults to VS Code.
 
-```json
-{
-  "mcp": {
-    "servers": {
-      "bit-cli": {
-        "command": "bit",
-        "args": ["mcp-server", "--extended"]
-      }
-    }
-  }
-}
+#### Supported Editors
+
+- **VS Code**: `bit mcp-server setup vscode` (or just `bit mcp-server setup`)
+- **Cursor**: `bit mcp-server setup cursor`
+- **Windsurf**: `bit mcp-server setup windsurf`
+
+#### Configuration Options
+
+- `--global`: Apply configuration globally (user settings) instead of workspace settings
+- `--extended`: Configure with extended mode enabled
+- `--consumer-project`: Configure for consumer projects
+- `--include-only <commands>`: Specify subset of commands to expose
+- `--include-additional <commands>`: Add specific commands to the available tools
+- `--exclude <commands>`: Prevent specific commands from being exposed
+
+#### Examples
+
+```bash
+# Basic VS Code setup (workspace level)
+bit mcp-server setup
+
+# Global setup for Cursor with extended mode
+bit mcp-server setup cursor --global --extended
+
+# Setup for Windsurf with consumer project mode
+bit mcp-server setup windsurf --consumer-project
 ```
 
-For consumer projects that only use Bit component packages:
+#### Manual Configuration
+
+If you need to manually configure the settings, here's a basic example for VS Code:
+
+1. Open VS Code settings (JSON) by pressing `Ctrl + Shift + P` (or `Cmd + Shift + P` on macOS) and typing `Preferences: Open Settings (JSON)`
+2. Add the following configuration:
 
 ```json
 {
@@ -80,7 +99,7 @@ For consumer projects that only use Bit component packages:
     "servers": {
       "bit-cli": {
         "command": "bit",
-        "args": ["mcp-server", "--consumer-project"]
+        "args": ["mcp-server"]
       }
     }
   }
@@ -110,23 +129,19 @@ The Bit CLI MCP Server operates in three modes and provides several specialized
 
 ### Default Mode
 
-In default mode, the server exposes a minimal set of essential tools focused on component discovery and creation. This ensures optimal performance and safety:
+In default mode, the server exposes a minimal set of essential tools focused on core functionality. This ensures optimal performance and safety:
 
-- **Individual CLI Command Tools:**
+- **Always Available Tools:**
 
-  - `bit_create`: Generate components from templates
-  - `bit_schema`: Retrieve component API schema from workspace or remote scopes
   - `bit_remote_search`: Search for components in remote scopes
-
-- **Specialized Composite Tools:**
-
   - `bit_workspace_info`: Get comprehensive workspace information including status, components list, apps, templates, and dependency graph
   - `bit_component_details`: Get detailed information about a specific component including basic info and optionally its public API schema
-  - `bit_commands_info`: Get information about available Bit commands and their groups
-
-- **Generic Execution Tools:**
   - `bit_query`: Execute read-only Bit commands that safely inspect workspace and component state without making modifications
   - `bit_execute`: Execute any Bit command, including those that modify workspace or repository state (use with caution)
+  - `bit_commands_list`: Get all available Bit commands with descriptions and groups (for command discovery)
+  - `bit_command_help`: Get detailed help for a specific Bit command including syntax, arguments, flags, and usage examples
+
+> **Command Discovery vs. Command Help**: Use `bit_commands_list` to discover what commands are available in Bit, then use `bit_command_help` with a specific command name to get detailed usage information including arguments, flags, and examples.
 
 ### Consumer Project Mode (--consumer-project)
 
@@ -134,7 +149,6 @@ This mode is designed for applications or projects that are not Bit workspaces b
 
 - `bit_schema`: Retrieves component API schema from remote scopes (automatically adds `--remote` flag)
 - `bit_show`: Displays component information from remote scopes (automatically adds `--remote` flag)
-- `bit_remote_search`: Searches for components in remote scopes
 
 In this mode:
 
@@ -179,8 +193,8 @@ To customize the available tools beyond the default set or extended mode:
 # Include only specific tools
 bit mcp-server --include-only "status,show,tag,snap,import,export"
 
-# Add specific tools to the default set
-bit mcp-server --include-additional "build,lint,format"
+# Add specific tools to the available tools
+bit mcp-server --include-additional "build,lint,format,create,schema"
 
 # For consumer projects (non-Bit workspaces)
 bit mcp-server --consumer-project

package/dist/cli-mcp-server.main.runtime.d.ts

@@ -1,6 +1,7 @@
 import { CLIMain } from '@teambit/cli';
 import { Logger, LoggerMain } from '@teambit/logger';
 import { Http } from '@teambit/scope.network';
+import { SetupOptions } from './setup-utils';
 export declare class CliMcpServerMain {
     private cli;
     private logger;
@@ -43,11 +44,11 @@ export declare class CliMcpServerMain {
     private buildCommandArgs;
     private getToolName;
     private registerToolForCommand;
-    private registerToolForRemote;
     private registerRemoteSearchTool;
     private registerWorkspaceInfoTool;
     private registerComponentDetailsTool;
-    private registerCommandsInfoTool;
+    private registerCommandsListTool;
+    private registerCommandHelpTool;
     private registerQueryTool;
     private registerExecuteTool;
     private processSubCommands;
@@ -68,6 +69,8 @@ export declare class CliMcpServerMain {
      * Helper method to safely execute a bit command with error handling
      */
     private safeBitCommandExecution;
+    getEditorDisplayName(editor: string): string;
+    setupEditor(editor: string, options: SetupOptions, workspaceDir?: string): Promise<void>;
     static slots: never[];
     static dependencies: import("@teambit/harmony").Aspect[];
     static runtime: import("@teambit/harmony").RuntimeDefinition;