Tools reference
The Bit Cloud MCP server exposes tools that let AI agents discover, inspect, and browse your components, scopes, apps, and lanes. All tools require authentication.
search_components, review with read_components, then read source with read-file when needed.Discovery
orientation
Get a high-level overview of all scopes in a Bit account. Use this as a starting point to understand the organization's domain structure.
| Parameter | Type | Required | Description |
|---|---|---|---|
owner | string | yes | Bit account name (e.g., acme, teambit) |
search_components
Search for components across an account's scopes. Use specific terms — avoid generic words like "component" or "ui".
| Parameter | Type | Required | Description |
|---|---|---|---|
queries | string[] | yes | Array of search queries (e.g., ["date picker", "form validation"]) |
owner | string | no | Bit account to search in. Defaults to the token's account. |
Scopes
read_scope
Read scope metadata, aspect configuration, and its first 25 components. For scopes with more components, use list_components to paginate.
| Parameter | Type | Required | Description |
|---|---|---|---|
scopeId | string | yes | Scope ID (e.g., acme.design, bitdev.base-ui) |
list_components
List components in a scope with pagination. Returns slim component info — ID, description, and package name.
| Parameter | Type | Required | Description |
|---|---|---|---|
scopeId | string | yes | Scope ID to list from |
offset | number | no | Number of components to skip (default: 0) |
limit | number | no | Max results to return (default: 25, max: 50) |
Components
read_components
Retrieve full component details — dependencies, API reference, documentation, and file paths. Use search_components or list_components to find component IDs first.
| Parameter | Type | Required | Description |
|---|---|---|---|
componentIds | string[] | yes | Component IDs to inspect (max 10). e.g., ["acme.design/actions/button"] |
includeApiReference | boolean | no | Include exported types and function signatures (default: true) |
laneId | string | no | Lane ID for lane-specific versions |
read-file
Read the source code of a specific file in a component. Use read_components first to discover available file paths.
| Parameter | Type | Required | Description |
|---|---|---|---|
componentId | string | yes | Component ID, optionally with version (e.g., acme.design/actions/[email protected]) |
filePath | string | yes | File path within the component |
Apps
list_apps
List deployed applications for an account.
| Parameter | Type | Required | Description |
|---|---|---|---|
owner | string | no | Bit account to list apps from. Defaults to the token's account. |
laneId | string | no | Lane ID for lane-specific app versions |
Lanes
list_lanes
List lanes with filtering options. Returns lane metadata including component count, status, and creation date.
| Parameter | Type | Required | Description |
|---|---|---|---|
owner | string | no | Filter by account owner |
scopes | string[] | no | Filter by scope IDs |
users | string[] | no | Filter by lane author usernames |
search | string | no | Search by lane name or ID |
deleted | boolean | no | Include deleted lanes (default: false) |
limit | number | no | Page size (default: 20) |
offset | number | no | Pagination offset |
read_lanes
Read full lane details — metadata and the components on the lane.
| Parameter | Type | Required | Description |
|---|---|---|---|
laneIds | string[] | yes | Lane IDs to read (e.g., ["acme.accounts/fix-login"]) |
edit_lane
Update a lane's description or display name. Requires a user token — organization access tokens cannot modify lanes.
| Parameter | Type | Required | Description |
|---|---|---|---|
laneId | string | yes | Lane ID to edit (e.g., acme.accounts/fix-login) |
description | string | no | Updated description |
displayName | string | no | Updated display name |