@teambit/cli-mcp-server 0.0.0-00149e000ea14bbdcb0391c0d576b4a2b40f8cde

package/README.docs.mdx

@@ -0,0 +1,117 @@
+# Bit CLI MCP Server
+
+The Bit CLI MCP Server provides a [Model Context Protocol (MCP)](https://github.com/modelcontextprotocol/mcp) interface to Bit's command-line functionality. It acts as a bridge between MCP clients (such as VS Code, AI tools, or your own applications) and the Bit CLI, enabling programmatic access to Bit workspace and component management operations.
+
+## Setup
+
+### Installation
+
+The Bit CLI MCP Server is included with Bit. To set it up with your IDE, run:
+
+```bash
+# Basic setup for VS Code (default)
+bit mcp-server setup
+
+# Other supported editors
+bit mcp-server setup [vscode|cursor|windsurf|roo|cline|claude-code]
+
+# For consumer projects (non-Bit workspaces that only consume Bit components)
+bit mcp-server setup --consumer-project
+```
+
+#### Recommended Setup Steps
+
+After installation, consider these helpful setup steps:
+
+1. **For new workspaces**: Set your default scope so the search tool knows which organization to search:
+
+   ```bash
+   bit scope set <your-org.your-scope>
+   ```
+
+2. **Generate rules/instructions** (if you haven't already):
+
+   ```bash
+   bit mcp-server rules
+   ```
+
+   This provides the AI agent with comprehensive guidance about Bit and MCP server functionality.
+
+3. **VS Code users**: Make sure to select "agent" mode instead of "ask" mode in the chat interface. For first-time users, open the command palette and search for "MCP: List servers" to find and start the Bit server.
+
+### Manual Configuration
+
+For IDEs not supported by the automatic setup, add this MCP server configuration:
+
+```json
+{
+  "servers": {
+    "bit-cli": {
+      "type": "stdio",
+      "command": "bit",
+      "args": ["mcp-server", "start"]
+    }
+  }
+}
+```
+
+### Configuration Options
+
+- `--global`: Apply configuration globally (user settings) instead of workspace settings
+- `--consumer-project`: For non-Bit workspaces that only consume Bit components as packages
+- `--include-additional <commands>`: Add specific commands to the available tools (comma-separated list)
+
+## Usage
+
+### Running the Server
+
+To manually start the server:
+
+```bash
+bit mcp-server start [options]
+```
+
+Options:
+
+- `--consumer-project`: For non-Bit workspaces that only consume Bit component packages
+- `--include-additional <commands>`: Add specific commands to the available tools (comma-separated list)
+
+### Generating AI Rules
+
+Create instruction files for AI assistants:
+
+```bash
+bit mcp-server rules [vscode|cursor|windsurf|roo|cline|claude-code] [options]
+```
+
+Options:
+
+- `--global`: Write rules to global configuration
+- `--consumer-project`: Generate rules for consumer projects
+- `--print`: Print rules content to screen
+
+## Available Tools
+
+The Bit CLI MCP Server operates in two modes and provides several specialized tools:
+
+### Default Mode
+
+In default mode, the server exposes a minimal set of essential tools focused on core functionality:
+
+- `bit_remote_search`: Search for components with automatic organization detection from workspace's defaultScope (e.g., "teambit" from "teambit.defender"). Executes multiple queries in parallel and deduplicates results. Use arrays of related terms or synonyms for better results.
+- `bit_workspace_info`: Get comprehensive workspace information by combining multiple data sources (status, components, apps, templates, dependency graph). Includes current lane information.
+- `bit_component_details`: Get detailed information about multiple components in parallel (up to 5 max to prevent context overload). Includes documentation from .docs.mdx files, example usage from composition files, and optionally the component's public API schema with exported functions/types. Returns partial results with detailed failure information if some components fail.
+- `bit_create`: Create components using templates with batch support. Supports multiple component names in single call and extensive configuration options (namespace, scope, environment). Validates template existence and prevents conflicts.
+- `bit_query`: Execute read-only Bit commands from a curated whitelist of safe commands (status, list, show, info, diff, log, graph, etc.). Prevents accidental workspace modifications.
+- `bit_execute`: Execute any Bit command including those that modify workspace state. Use with caution as it allows all operations including destructive ones.
+- `bit_commands_list`: Get all available Bit commands with descriptions, grouping, and subcommand discovery for comprehensive command exploration.
+- `bit_command_help`: Get detailed help for specific commands including arguments metadata, flag types, usage examples, and subcommand relationships.
+
+> **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)
+
+For projects that consume Bit components as packages but aren't Bit workspaces:
+
+- `bit_remote_search`: Search for components across all organizations available to the logged-in user (requires `bit login`). Executes multiple queries in parallel and deduplicates results.
+- `bit_remote_component_details`: Get comprehensive remote component information by combining show and schema commands. Gracefully handles schema failures while providing basic component details.

package/dist/README.docs.mdx

@@ -0,0 +1,117 @@
+# Bit CLI MCP Server
+
+The Bit CLI MCP Server provides a [Model Context Protocol (MCP)](https://github.com/modelcontextprotocol/mcp) interface to Bit's command-line functionality. It acts as a bridge between MCP clients (such as VS Code, AI tools, or your own applications) and the Bit CLI, enabling programmatic access to Bit workspace and component management operations.
+
+## Setup
+
+### Installation
+
+The Bit CLI MCP Server is included with Bit. To set it up with your IDE, run:
+
+```bash
+# Basic setup for VS Code (default)
+bit mcp-server setup
+
+# Other supported editors
+bit mcp-server setup [vscode|cursor|windsurf|roo|cline|claude-code]
+
+# For consumer projects (non-Bit workspaces that only consume Bit components)
+bit mcp-server setup --consumer-project
+```
+
+#### Recommended Setup Steps
+
+After installation, consider these helpful setup steps:
+
+1. **For new workspaces**: Set your default scope so the search tool knows which organization to search:
+
+   ```bash
+   bit scope set <your-org.your-scope>
+   ```
+
+2. **Generate rules/instructions** (if you haven't already):
+
+   ```bash
+   bit mcp-server rules
+   ```
+
+   This provides the AI agent with comprehensive guidance about Bit and MCP server functionality.
+
+3. **VS Code users**: Make sure to select "agent" mode instead of "ask" mode in the chat interface. For first-time users, open the command palette and search for "MCP: List servers" to find and start the Bit server.
+
+### Manual Configuration
+
+For IDEs not supported by the automatic setup, add this MCP server configuration:
+
+```json
+{
+  "servers": {
+    "bit-cli": {
+      "type": "stdio",
+      "command": "bit",
+      "args": ["mcp-server", "start"]
+    }
+  }
+}
+```
+
+### Configuration Options
+
+- `--global`: Apply configuration globally (user settings) instead of workspace settings
+- `--consumer-project`: For non-Bit workspaces that only consume Bit components as packages
+- `--include-additional <commands>`: Add specific commands to the available tools (comma-separated list)
+
+## Usage
+
+### Running the Server
+
+To manually start the server:
+
+```bash
+bit mcp-server start [options]
+```
+
+Options:
+
+- `--consumer-project`: For non-Bit workspaces that only consume Bit component packages
+- `--include-additional <commands>`: Add specific commands to the available tools (comma-separated list)
+
+### Generating AI Rules
+
+Create instruction files for AI assistants:
+
+```bash
+bit mcp-server rules [vscode|cursor|windsurf|roo|cline|claude-code] [options]
+```
+
+Options:
+
+- `--global`: Write rules to global configuration
+- `--consumer-project`: Generate rules for consumer projects
+- `--print`: Print rules content to screen
+
+## Available Tools
+
+The Bit CLI MCP Server operates in two modes and provides several specialized tools:
+
+### Default Mode
+
+In default mode, the server exposes a minimal set of essential tools focused on core functionality:
+
+- `bit_remote_search`: Search for components with automatic organization detection from workspace's defaultScope (e.g., "teambit" from "teambit.defender"). Executes multiple queries in parallel and deduplicates results. Use arrays of related terms or synonyms for better results.
+- `bit_workspace_info`: Get comprehensive workspace information by combining multiple data sources (status, components, apps, templates, dependency graph). Includes current lane information.
+- `bit_component_details`: Get detailed information about multiple components in parallel (up to 5 max to prevent context overload). Includes documentation from .docs.mdx files, example usage from composition files, and optionally the component's public API schema with exported functions/types. Returns partial results with detailed failure information if some components fail.
+- `bit_create`: Create components using templates with batch support. Supports multiple component names in single call and extensive configuration options (namespace, scope, environment). Validates template existence and prevents conflicts.
+- `bit_query`: Execute read-only Bit commands from a curated whitelist of safe commands (status, list, show, info, diff, log, graph, etc.). Prevents accidental workspace modifications.
+- `bit_execute`: Execute any Bit command including those that modify workspace state. Use with caution as it allows all operations including destructive ones.
+- `bit_commands_list`: Get all available Bit commands with descriptions, grouping, and subcommand discovery for comprehensive command exploration.
+- `bit_command_help`: Get detailed help for specific commands including arguments metadata, flag types, usage examples, and subcommand relationships.
+
+> **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)
+
+For projects that consume Bit components as packages but aren't Bit workspaces:
+
+- `bit_remote_search`: Search for components across all organizations available to the logged-in user (requires `bit login`). Executes multiple queries in parallel and deduplicates results.
+- `bit_remote_component_details`: Get comprehensive remote component information by combining show and schema commands. Gracefully handles schema failures while providing basic component details.

package/dist/cli-mcp-server.aspect.d.ts

@@ -0,0 +1,2 @@
+import { Aspect } from '@teambit/harmony';
+export declare const CliMcpServerAspect: Aspect;

package/dist/cli-mcp-server.aspect.js

@@ -0,0 +1,18 @@
+"use strict";
+
+Object.defineProperty(exports, "__esModule", {
+  value: true
+});
+exports.CliMcpServerAspect = void 0;
+function _harmony() {
+  const data = require("@teambit/harmony");
+  _harmony = function () {
+    return data;
+  };
+  return data;
+}
+const CliMcpServerAspect = exports.CliMcpServerAspect = _harmony().Aspect.create({
+  id: 'teambit.mcp/cli-mcp-server'
+});
+
+//# sourceMappingURL=cli-mcp-server.aspect.js.map

package/dist/cli-mcp-server.aspect.js.map

@@ -0,0 +1 @@
+{"version":3,"names":["_harmony","data","require","CliMcpServerAspect","exports","Aspect","create","id"],"sources":["cli-mcp-server.aspect.ts"],"sourcesContent":["import { Aspect } from '@teambit/harmony';\n\nexport const CliMcpServerAspect = Aspect.create({\n  id: 'teambit.mcp/cli-mcp-server',\n});\n"],"mappings":";;;;;;AAAA,SAAAA,SAAA;EAAA,MAAAC,IAAA,GAAAC,OAAA;EAAAF,QAAA,YAAAA,CAAA;IAAA,OAAAC,IAAA;EAAA;EAAA,OAAAA,IAAA;AAAA;AAEO,MAAME,kBAAkB,GAAAC,OAAA,CAAAD,kBAAA,GAAGE,iBAAM,CAACC,MAAM,CAAC;EAC9CC,EAAE,EAAE;AACN,CAAC,CAAC","ignoreList":[]}

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

@@ -0,0 +1,123 @@
+import type { CLIMain } from '@teambit/cli';
+import type { Logger, LoggerMain } from '@teambit/logger';
+import { Http } from '@teambit/scope.network';
+import type { SetupOptions, RulesOptions } from '@teambit/mcp.mcp-config-writer';
+export declare class CliMcpServerMain {
+    private cli;
+    private logger;
+    private bitBin;
+    private _http;
+    private isConsumerProjectMode;
+    private serverPort?;
+    private serverUrl?;
+    private serverToken?;
+    private serverProcess;
+    private serverInitPromise?;
+    private readonly readOnlyCommands;
+    constructor(cli: CLIMain, logger: Logger);
+    getHttp(): Promise<Http>;
+    /**
+     * Discover or spawn a bit-server, then read its bearer token. Concurrent
+     * callers share a single in-flight promise so they can't race each other
+     * into spawning duplicate servers (which would otherwise overwrite the
+     * shared `server-token.txt`).
+     */
+    private ensureBitServer;
+    private getBitServerPort;
+    /**
+     * Build the URL used to dial the local bit-server. Mirrors the api-server's
+     * bind host: `BIT_SERVER_HOST` lets hosted environments (e.g. cloud
+     * workspaces) reach bit-server on a non-loopback interface. `0.0.0.0` /
+     * `::` are bind-only wildcards (not valid destinations) so dial loopback
+     * instead; raw IPv6 addresses get bracketed for URL safety.
+     */
+    private buildServerUrl;
+    /**
+     * Read the bearer token written by bit-server (1.13.166+) for authenticating
+     * to the local HTTP API. Returns undefined for older bit-server versions
+     * that don't write a token file (no auth required), or when the workspace
+     * has no scope yet. Other read errors (EACCES, etc.) surface so the user
+     * sees the real cause instead of a misleading 401.
+     */
+    private getBitServerToken;
+    /**
+     * Start a new bit-server process
+     */
+    private startBitServer;
+    /**
+     * Call bit-server API endpoint using cli-raw route
+     */
+    private callBitServerAPI;
+    /**
+     * Call bit-server API endpoint using IDE route
+     */
+    private callBitServerIDEAPI;
+    /**
+     * Generic method to call bit-server API with different routes
+     */
+    private callBitServerAPIWithRoute;
+    runMcpServer(options: {
+        includeAdditional?: string;
+        bitBin?: string;
+        consumerProject?: boolean;
+    }): Promise<void>;
+    private shouldIncludeCommand;
+    private buildZodSchema;
+    private buildCommandArgs;
+    private getToolName;
+    private registerToolForCommand;
+    /**
+     * Read and parse workspace.jsonc file from a given directory
+     */
+    private readWorkspaceJsonc;
+    /**
+     * Extract owner from defaultScope in workspace.jsonc
+     * If defaultScope contains a dot, split by dot and take the first part
+     */
+    private extractOwnerFromWorkspace;
+    private registerRemoteSearchTool;
+    private registerRemoteComponentDetailsTool;
+    private registerWorkspaceInfoTool;
+    private registerComponentDetailsTool;
+    private registerCreateTool;
+    private registerCommandsListTool;
+    private registerCommandHelpTool;
+    private registerQueryTool;
+    private registerExecuteTool;
+    private processSubCommands;
+    private runBit;
+    /**
+     * Helper method to execute a bit-server API call with standardized error handling
+     */
+    private executeBitServerCommand;
+    /**
+     * Helper method to format any result as CallToolResult
+     */
+    private formatAsCallToolResult;
+    /**
+     * Helper method to format error as CallToolResult
+     */
+    private formatErrorAsCallToolResult;
+    /**
+     * Helper method to safely execute a bit command with error handling
+     */
+    private safeBitCommandExecution;
+    private validateBitBin;
+    getEditorDisplayName(editor: string): string;
+    /**
+     * Get the path to the editor config file based on editor type and scope
+     */
+    getEditorConfigPath(editor: string, isGlobal: boolean, workspaceDir?: string): string;
+    setupEditor(editor: string, options: SetupOptions, workspaceDir?: string): Promise<void>;
+    writeRulesFile(editor: string, options: RulesOptions, workspaceDir?: string): Promise<void>;
+    getRulesContent(consumerProject?: boolean, forceStandard?: boolean): Promise<string>;
+    /**
+     * Get the path to the rules file based on editor type and scope
+     */
+    getRulesFilePath(editor: string, isGlobal: boolean, workspaceDir?: string): string;
+    static slots: never[];
+    static dependencies: import("@teambit/harmony").Aspect[];
+    static runtime: import("@teambit/harmony").RuntimeDefinition;
+    static provider([cli, loggerMain]: [CLIMain, LoggerMain]): Promise<CliMcpServerMain>;
+}
+export default CliMcpServerMain;