@teambit/cli-mcp-server 0.0.0-1ed79eba7ca236740e6158efa8a6f27425ecaa11

package/README.docs.mdx

@@ -0,0 +1,250 @@
+# 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, enabling programmatic access to Bit workspace and component management operations. This server exposes Bit CLI commands as MCP tools, making it possible to automate, script, or integrate Bit operations with other tools and platforms.
+
+## Overview
+
+This server acts as a bridge between MCP clients (such as VS Code, AI tools, or your own applications) and the Bit CLI. It leverages the Bit server API for efficient communication and provides both individual CLI command tools and specialized composite tools for common workflows. The server automatically manages a Bit server instance in the background for optimal performance.
+
+## Installation
+
+### Prerequisites
+
+- Node.js (v18 or later recommended)
+- Bit CLI installed and available in your PATH
+
+### Getting Started
+
+The Bit CLI MCP Server is included with Bit. If you have Bit installed, you can run the server using:
+
+```
+bit mcp-server start
+```
+
+## Usage
+
+### Command-Line Options
+
+```
+bit mcp-server start [options]
+```
+
+Options:
+
+- `--consumer-project`: For non-Bit workspaces that only consume Bit component packages. Enables only "bit_remote_search" and "bit_remote_component_details" tools and automatically adds the "--remote" flag to relevant commands.
+- `--include-additional <commands>`: Add specific commands to the available tools (comma-separated list)
+
+### Integrating with IDEs
+
+The easiest way to integrate the MCP server with your IDE is to use the `setup` command:
+
+```bash
+# Basic setup for VS Code (default)
+bit mcp-server setup
+```
+
+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]
+```
+
+This command automatically configures the MCP server settings in your chosen editor. If no editor is specified, it defaults to VS Code.
+
+#### 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
+- `--consumer-project`: Configure for consumer projects
+- `--include-additional <commands>`: Add specific commands to the available tools
+
+#### Examples
+
+```bash
+# Basic VS Code setup (workspace level)
+bit mcp-server setup
+
+# Global setup for Cursor
+bit mcp-server setup cursor --global
+
+# Setup with consumer project mode
+bit mcp-server setup --consumer-project
+```
+
+#### Manual Configuration
+
+If you need to manually configure the settings, here's how to set up VS Code MCP integration:
+
+**For workspace-specific configuration:**
+
+1. Create a `.vscode/mcp.json` file in your workspace folder
+2. Add the following configuration:
+
+```json
+{
+  "servers": {
+    "bit-cli": {
+      "type": "stdio",
+      "command": "bit",
+      "args": ["mcp-server", "start"]
+    }
+  }
+}
+```
+
+**For global configuration:**
+
+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
+{
+  "mcp": {
+    "servers": {
+      "bit-cli": {
+        "type": "stdio",
+        "command": "bit",
+        "args": ["mcp-server", "start"]
+      }
+    }
+  }
+}
+```
+
+### Programmatic Usage
+
+```javascript
+import { McpClient } from '@modelcontextprotocol/sdk/client';
+
+async function example() {
+  const client = await McpClient.spawn('bit', ['mcp-server', 'start']);
+
+  // Call a Bit CLI tool via MCP
+  const result = await client.callTool('bit_status', { cwd: '/path/to/workspace' });
+  console.log(result.content[0].text);
+
+  // Close the connection when done
+  await client.close();
+}
+```
+
+## 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. This ensures optimal performance and safety:
+
+- **Always Available Tools:**
+
+  - `bit_remote_search`: Search for components in remote scopes
+  - `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_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)
+
+This mode is designed for applications or projects that are not Bit workspaces but need to consume or work with Bit components as packages. It provides a minimal set of tools focused on component discovery and information:
+
+- `bit_remote_search`: Search for components in remote scopes
+- `bit_remote_component_details`: Get detailed information about a remote component including basic info and its public API schema (combines the functionality of show and schema commands)
+
+In this mode:
+
+1. You don't need a Bit workspace initialization
+2. Only these 2 tools are available (no workspace-specific tools)
+3. The `--remote` flag is automatically added to component detail queries
+4. The `cwd` parameter is still required but can be any directory (not necessarily a Bit workspace)
+5. You can still add additional tools with the `--include-additional` flag
+
+## Tool Parameters
+
+All tools accept a `cwd` parameter specifying the workspace path. Additional parameters vary by command.
+
+Example tool call for `bit_status`:
+
+```json
+{
+  "cwd": "/path/to/workspace",
+  "warnings": true,
+  "json": true
+}
+```
+
+## Custom Tool Selection
+
+To customize the available tools:
+
+```
+# Add specific tools to the available tools
+bit mcp-server start --include-additional "build,lint,format,create,schema"
+
+# For consumer projects (non-Bit workspaces)
+bit mcp-server start --consumer-project
+
+# Add specific tools to the consumer project set
+bit mcp-server start --consumer-project --include-additional "deps,get,preview"
+```
+
+### Writing AI Assistant Rules
+
+The MCP server provides a `rules` command to create instruction files for AI assistants:
+
+```bash
+bit mcp-server rules [vscode|cursor|windsurf|cline] [options]
+```
+
+This command creates rules/instructions markdown files that provide guidance to AI assistants on how to effectively use the Bit MCP server and follow best practices when working with Bit components.
+
+#### Supported Editors
+
+- **VS Code**: `bit mcp-server rules vscode` (or just `bit mcp-server rules`)
+- **Cursor**: `bit mcp-server rules cursor`
+- **Windsurf**: `bit mcp-server rules windsurf`
+- **Cline**: `bit mcp-server rules cline`
+
+#### Configuration Options
+
+- `--global`: Write rules to global configuration (default: workspace-specific)
+- `--print`: Print rules content to screen instead of writing to file
+- `--consumer-project`: Generate rules for consumer projects that only use Bit components as packages
+
+#### Examples
+
+```bash
+# Basic VS Code rules (workspace level)
+bit mcp-server rules
+
+# Global rules for Cursor
+bit mcp-server rules cursor --global
+
+# Consumer project rules for VS Code
+bit mcp-server rules --consumer-project
+
+# Global rules for Cline (macOS only)
+bit mcp-server rules cline --global
+
+# Workspace-specific rules for Cline
+bit mcp-server rules cline
+
+# Print rules content to screen for manual setup
+bit mcp-server rules --print
+
+# Print consumer project content for Windsurf (requires manual addition to .windsurfrules)
+bit mcp-server rules windsurf --print --consumer-project
+```

package/bit-rules-consumer-template.md

@@ -0,0 +1,11 @@
+---
+applyTo: '**'
+---
+
+## How to Install and Use Bit Components
+
+- Bit Components are reusable pieces of code in the form of node packages.
+- Search for Bit Components using `bit_remote_search` tool.
+- Use `bit_remote_component_details` only on Bit Components to get information like package name (to use when installing, e.g. `npm install <package-name>`), APIs and documentation (to use when using in code).
+- If a user is requesting functionality, you can search if there are available components that implement it using `bit_remote_search`.
+- Filter my search with my account name "ACCOUNT" to find components you have created or are a maintainer of.

package/bit-rules-template.md

@@ -0,0 +1,115 @@
+---
+applyTo: '**'
+---
+
+# Bit MCP Agent Instructions
+
+## Core Objectives
+
+- Your goal is to efficiently automate Bit workflows and help users manage and reuse components.
+- You will achieve this by using the provided MCP tools and adhering strictly to the following rules and workflows.
+
+## Core Philosophy for Building with Bit
+
+- **Deconstruct to Compose:** Build applications by composing independent and reusable components, with each component being developed, tested, and versioned in isolation.
+- **Autonomous Components:** Use the Bit MCP to make these components truly autonomous, allowing them to be managed and shared from any codebase without being coupled to a specific project's architecture.
+- **Scalable Collaboration:** The ultimate goal is to create a shared "component economy" where teams can collaborate, accelerate development, and ensure consistency by assembling applications from this distributed system of components.
+
+## Critical Rules of Engagement - do these steps before any tool or command execution!!!
+
+1. **Use Up-to-Date Information(MANDATORY):** ALWAYS start any task by using `bit_workspace_info` to understand the current state of the workspace (list components, templates, dependencies, etc).
+2. **MCP Tools First:** You MUST use the provided MCP tools to interact with Bit. Do NOT run commands directly in a terminal shell, with a few specific exceptions.
+3. **Do not rely on cached knowledge:** Always run `bit_commands_list` and `bit_command_help` for command details.
+4. **Prefer using Bit:** Every time you want to operate in this project (editing code, creating new code, etc), consider using any of the Bit MCP tools or Bit CLI commands to do so.
+
+## Core Principles of Building with Bit
+
+- **Reuse Before Creating or Modifying(MANDATORY):** Before creating _any_ new component or modify _any_ file, you MUST first search for existing components.
+  - Use `bit_workspace_info` to check for local and existing components.
+  - Use `bit_remote_search` to find components on the remote scope.
+  - Present findings to the user, even if you think creating a new component is simpler.
+- **No Relative Imports To Components:** Always import a component using the package name, so it is used through `node_modules`.
+- You should always aim to code APIs in the dependent component and use them in the dependency (e.g. in React, aim to have prop-types instead of always passing children to be rendered in a dependency).
+
+## Tooling & Command Execution Hierarchy
+
+This is the decision-making process for executing any Bit operation.
+
+### Step 1: Choose the Correct Generic Execution Tool
+
+- If no dedicated tool exists, you must use one of the generic execution tools. Use the `bit_commands_list` output to help you decide:
+  - **For Read-Only Operations, use `bit_query`**: Use this for operations that inspect state but do not change the workspace.
+  - **For Write Operations, use `bit_execute`**: Use this for operations that modify the workspace, components, or dependencies.
+
+### Step 2: Check for Terminal Exceptions
+
+- The following commands have rich, interactive, or streaming output and should be run directly in the user's terminal. You should construct the command and advise the user to run it.
+  - `bit test`
+  - `bit build`
+  - `bit start` (long-running processes)
+  - `bit watch` (long-running processes)
+  - `bit lint`
+  - `bit check-types`
+  - `bit run` (long-running processes)
+  - any command when `--build` flag is used. (build can take long)
+
+## Core Workflows
+
+### Workflow: Error Diagnosis in a Bit Workspace
+
+- `bit_workspace_info` with the "warnings" option to detect errors. Output includes possible solutions, follow them.
+- Rerun `bit_workspace_info` to validate fixes. If error persists, use `bit_component_details` on relevant component(s) for more information.
+
+### Workflow: In-Component Code Issues
+
+- For code issues (compile, lint, test, type checking), run the relevant terminal command and pass the component ID (e.g. `bit test COMPONENT_ID`).
+- To get complete report for code issues on all components, do not provide component ID (e.g. `bit test`).
+- Adding `--log` CLI option gives more details on errors.
+
+### Workflow: Generating New Components, Feature or Apps
+
+- **Follow Core Principle #1 Reuse Before Creating or Modifying.**
+- `bit_workspace_info` lists templates for new components.
+- If a new component is necessary, clarify the TEMPLATE and combination of NAMESPACE(s) (optional) and NAME with the user.
+- Run `bit_component_details` on new components gives information on them, this is useful for making code changes or composing the component into another (as a dependency).
+- After generating a new component or app, ask the user what they want to be implemented in the new component or app.
+
+### Workflow: Adding Functionality (feature, page, module, function, etc) to Bit Components and Apps
+
+- **Follow Critical Principle #1 Reuse Before Creating or Modifying.**
+- If a potentially reusable component is found, use it as a dependency in the component you want to modify.
+  **Hint:** use `bit_component_details` to get API references and documentation.
+  **Follow Critical Principle #2 No Relative Imports Between Components**.
+- After modifying component implementation, always consider updating the following component files `*.composition.*`, `*.docs.mdx`, `*.spec.*`.
+
+### Workflow: USE or DEVELOP a Component
+
+- Use `bit_component_details` to get the component location.
+- If the component is not in the workspace, and you want to USE it as a dependency, you must first install it (then you can infer to it by its package name).
+- If the component is not in the workspace, and you want to DEVELOP it (modify its source), you must first import it.
+
+### Workflow: Collaboration, Change Management and Version Control
+
+- Bit uses a concept called "Lanes" to manage changes across components, this is similar to Git branches.
+- Use `bit_workspace_info` to identify the current active lane.
+- You must not snap or export components directly to the `main` lane.
+- Use `bit_execute` for "Bit Lane" commands.
+- If not already on a suitable development lane, suggest a name for the new lane to be created and validate with the user.
+- The workspace automatically switches to a new lane once created.
+- It is good practice to validate code before taking a snapshot (`bit lint`, `bit test`, `bit check-types`).
+- Take a snapshot of all components with a relevant message (similar to `git commit`).
+- Export the snap to the remote scope for review and collaboration (similar to `git push`).
+
+## Glossary
+
+- **Bit Component:** An extensible, portable software container. Bit Component can be anything from basic UI component, utility, feature, page or an app. Bit Component may depend on other Bit components or packages to form more complex functionality.
+- **Workspace:** A Bit-initialized directory containing components.
+- **Scope:** A collaboration server for components that defines ownership.
+- **Application (App):** A Bit Component with its own runtime. It is usually composed from various features and components.
+- **Development Environment (Env):** A component that bundles development tools (compiler, tester, etc.).
+- **Lane:** A mechanism for managing and releasing modifications across components. `main` is the default lane. Lane is similar in concept to a Git Branch.
+
+## Pointers to remember:
+
+- For generating ESlint or TypeScript configuration files execute the command `bit ws-config write --clean`
+- User may use different terms to describe components. Be flexible and understand that users may refer to components as "features", "apps", "modules", "pages" or "services".

package/dist/README.docs.mdx

@@ -0,0 +1,250 @@
+# 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, enabling programmatic access to Bit workspace and component management operations. This server exposes Bit CLI commands as MCP tools, making it possible to automate, script, or integrate Bit operations with other tools and platforms.
+
+## Overview
+
+This server acts as a bridge between MCP clients (such as VS Code, AI tools, or your own applications) and the Bit CLI. It leverages the Bit server API for efficient communication and provides both individual CLI command tools and specialized composite tools for common workflows. The server automatically manages a Bit server instance in the background for optimal performance.
+
+## Installation
+
+### Prerequisites
+
+- Node.js (v18 or later recommended)
+- Bit CLI installed and available in your PATH
+
+### Getting Started
+
+The Bit CLI MCP Server is included with Bit. If you have Bit installed, you can run the server using:
+
+```
+bit mcp-server start
+```
+
+## Usage
+
+### Command-Line Options
+
+```
+bit mcp-server start [options]
+```
+
+Options:
+
+- `--consumer-project`: For non-Bit workspaces that only consume Bit component packages. Enables only "bit_remote_search" and "bit_remote_component_details" tools and automatically adds the "--remote" flag to relevant commands.
+- `--include-additional <commands>`: Add specific commands to the available tools (comma-separated list)
+
+### Integrating with IDEs
+
+The easiest way to integrate the MCP server with your IDE is to use the `setup` command:
+
+```bash
+# Basic setup for VS Code (default)
+bit mcp-server setup
+```
+
+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]
+```
+
+This command automatically configures the MCP server settings in your chosen editor. If no editor is specified, it defaults to VS Code.
+
+#### 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
+- `--consumer-project`: Configure for consumer projects
+- `--include-additional <commands>`: Add specific commands to the available tools
+
+#### Examples
+
+```bash
+# Basic VS Code setup (workspace level)
+bit mcp-server setup
+
+# Global setup for Cursor
+bit mcp-server setup cursor --global
+
+# Setup with consumer project mode
+bit mcp-server setup --consumer-project
+```
+
+#### Manual Configuration
+
+If you need to manually configure the settings, here's how to set up VS Code MCP integration:
+
+**For workspace-specific configuration:**
+
+1. Create a `.vscode/mcp.json` file in your workspace folder
+2. Add the following configuration:
+
+```json
+{
+  "servers": {
+    "bit-cli": {
+      "type": "stdio",
+      "command": "bit",
+      "args": ["mcp-server", "start"]
+    }
+  }
+}
+```
+
+**For global configuration:**
+
+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
+{
+  "mcp": {
+    "servers": {
+      "bit-cli": {
+        "type": "stdio",
+        "command": "bit",
+        "args": ["mcp-server", "start"]
+      }
+    }
+  }
+}
+```
+
+### Programmatic Usage
+
+```javascript
+import { McpClient } from '@modelcontextprotocol/sdk/client';
+
+async function example() {
+  const client = await McpClient.spawn('bit', ['mcp-server', 'start']);
+
+  // Call a Bit CLI tool via MCP
+  const result = await client.callTool('bit_status', { cwd: '/path/to/workspace' });
+  console.log(result.content[0].text);
+
+  // Close the connection when done
+  await client.close();
+}
+```
+
+## 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. This ensures optimal performance and safety:
+
+- **Always Available Tools:**
+
+  - `bit_remote_search`: Search for components in remote scopes
+  - `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_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)
+
+This mode is designed for applications or projects that are not Bit workspaces but need to consume or work with Bit components as packages. It provides a minimal set of tools focused on component discovery and information:
+
+- `bit_remote_search`: Search for components in remote scopes
+- `bit_remote_component_details`: Get detailed information about a remote component including basic info and its public API schema (combines the functionality of show and schema commands)
+
+In this mode:
+
+1. You don't need a Bit workspace initialization
+2. Only these 2 tools are available (no workspace-specific tools)
+3. The `--remote` flag is automatically added to component detail queries
+4. The `cwd` parameter is still required but can be any directory (not necessarily a Bit workspace)
+5. You can still add additional tools with the `--include-additional` flag
+
+## Tool Parameters
+
+All tools accept a `cwd` parameter specifying the workspace path. Additional parameters vary by command.
+
+Example tool call for `bit_status`:
+
+```json
+{
+  "cwd": "/path/to/workspace",
+  "warnings": true,
+  "json": true
+}
+```
+
+## Custom Tool Selection
+
+To customize the available tools:
+
+```
+# Add specific tools to the available tools
+bit mcp-server start --include-additional "build,lint,format,create,schema"
+
+# For consumer projects (non-Bit workspaces)
+bit mcp-server start --consumer-project
+
+# Add specific tools to the consumer project set
+bit mcp-server start --consumer-project --include-additional "deps,get,preview"
+```
+
+### Writing AI Assistant Rules
+
+The MCP server provides a `rules` command to create instruction files for AI assistants:
+
+```bash
+bit mcp-server rules [vscode|cursor|windsurf|cline] [options]
+```
+
+This command creates rules/instructions markdown files that provide guidance to AI assistants on how to effectively use the Bit MCP server and follow best practices when working with Bit components.
+
+#### Supported Editors
+
+- **VS Code**: `bit mcp-server rules vscode` (or just `bit mcp-server rules`)
+- **Cursor**: `bit mcp-server rules cursor`
+- **Windsurf**: `bit mcp-server rules windsurf`
+- **Cline**: `bit mcp-server rules cline`
+
+#### Configuration Options
+
+- `--global`: Write rules to global configuration (default: workspace-specific)
+- `--print`: Print rules content to screen instead of writing to file
+- `--consumer-project`: Generate rules for consumer projects that only use Bit components as packages
+
+#### Examples
+
+```bash
+# Basic VS Code rules (workspace level)
+bit mcp-server rules
+
+# Global rules for Cursor
+bit mcp-server rules cursor --global
+
+# Consumer project rules for VS Code
+bit mcp-server rules --consumer-project
+
+# Global rules for Cline (macOS only)
+bit mcp-server rules cline --global
+
+# Workspace-specific rules for Cline
+bit mcp-server rules cline
+
+# Print rules content to screen for manual setup
+bit mcp-server rules --print
+
+# Print consumer project content for Windsurf (requires manual addition to .windsurfrules)
+bit mcp-server rules windsurf --print --consumer-project
+```

package/dist/bit-rules-consumer-template.md

@@ -0,0 +1,11 @@
+---
+applyTo: '**'
+---
+
+## How to Install and Use Bit Components
+
+- Bit Components are reusable pieces of code in the form of node packages.
+- Search for Bit Components using `bit_remote_search` tool.
+- Use `bit_remote_component_details` only on Bit Components to get information like package name (to use when installing, e.g. `npm install <package-name>`), APIs and documentation (to use when using in code).
+- If a user is requesting functionality, you can search if there are available components that implement it using `bit_remote_search`.
+- Filter my search with my account name "ACCOUNT" to find components you have created or are a maintainer of.