Skip to content

Commit aa5af95

Browse files
committed
docs: update readme
1 parent 6a86643 commit aa5af95

1 file changed

Lines changed: 22 additions & 53 deletions

File tree

packages/cli/README.md

Lines changed: 22 additions & 53 deletions
Original file line numberDiff line numberDiff line change
@@ -99,7 +99,7 @@ All-in-one command to get started quickly. This command combines `init`, feature
9999
and type generation in a single step. Use this for the fastest way to get up and running with Bucket.
100100

101101
```bash
102-
npx bucket new "My Feature" [--key my-feature] [--app-id ap123456789] [--key-format custom] [--out gen/features.ts] [--format react]
102+
npx bucket new "My Feature" [--app-id ap123456789] [--key my-feature] [--key-format custom] [--out gen/features.ts] [--format react]
103103
```
104104

105105
Options:
@@ -138,7 +138,7 @@ Create a new feature in your Bucket app.
138138
The command guides you through the feature creation process with interactive prompts if options are not provided.
139139

140140
```bash
141-
npx bucket features create "My Feature" [--key my-feature] [--app-id ap123456789] [--key-format custom]
141+
npx bucket features create "My Feature" [--app-id ap123456789] [--key my-feature] [--key-format custom]
142142
```
143143

144144
Options:
@@ -205,7 +205,7 @@ Grant or revoke access to specific features for companies, segments, and users.
205205
If no feature key is provided, you'll be prompted to select one from a list.
206206

207207
```bash
208-
npx bucket companies features access [featureKey] [--enable|--disable] [--companies <id...>] [--segments <id...>] [--users <id...>] [--app-id ap123456789]
208+
npx bucket companies features access [--app-id ap123456789] [featureKey] [--enable|--disable] [--companies <id...>] [--segments <id...>] [--users <id...>]
209209
```
210210

211211
Arguments:
@@ -252,7 +252,7 @@ Bucket provides powerful AI-assisted development capabilities through rules and
252252
The `rules` command helps you set up AI-specific rules for your project. These rules enable AI tools to better understand how to work with Bucket and feature flags and how they should be used in your codebase.
253253

254254
```bash
255-
npx bucket rules [--format cursor|copilot] [--yes]
255+
npx bucket rules [--format <cursor|copilot>] [--yes]
256256
```
257257

258258
Options:
@@ -266,67 +266,36 @@ This command will add rules to your project that provide AI tools with context a
266266

267267
## Model Context Protocol
268268

269-
The Model Context Protocol (MCP) is an open protocol that provides a standardized way to connect AI models to different data sources and tools. In the context of Bucket, MCP enables your development environment to understand your feature flags, their states, and their relationships within your codebase. This creates a seamless bridge between your feature management workflow and AI-powered development tools. MCP is in a very early stage of development and changes are frequent, if something isn't working please check out the [Model Context Protocol Website](https://modelcontextprotocol.io/) and open an [issue ticket here](https://github.com/bucketco/bucket-javascript-sdk/issues).
269+
The Model Context Protocol (MCP) is an open protocol that provides a standardized way to connect AI models to different data sources and tools. In the context of Bucket, MCP enables your development environment to understand your feature flags, their states, and their relationships within your codebase. This creates a seamless bridge between your feature management workflow and AI-powered development tools.
270+
271+
_**Note: The Bucket MCP server is now remote hosted and the `mcp` command has been repurposed to help you connect to the new server.**_
270272

271273
### Setting up MCP
272274

273-
MCP servers currently run locally on your machine. To start the MCP server run the CLI command from your Bucket initialized project directory:
275+
The `mcp` command helps you configure your editor or AI client to connect with Bucket's remote MCP server. This allows your AI tools to understand your feature flags and provide more contextual assistance.
274276

275277
```bash
276-
npx bucket mcp [--port <number|"auto">] [--app-id ap123456789]
278+
npx bucket mcp [--app-id <id>] [--editor <editor>] [--scope <local|global>]
277279
```
278280

279281
Options:
280282

281-
- `--port`: Port to run the SSE server on (defaults to 8050, "auto" for random port).
282-
- `--app-id`: App ID to use.
283-
284-
This will start an SSE server at `http://localhost:8050/sse` by default which you can connect to using your [client of choice](https://modelcontextprotocol.io/clients). Below are examples that work for [Cursor IDE](https://www.cursor.com/) and [Claude Desktop](https://claude.ai/download).
285-
286-
#### Server-Side Events (SSE)
287-
288-
```json
289-
{
290-
"mcpServers": {
291-
"Bucket": {
292-
"url": "http://localhost:8050/sse"
293-
}
294-
}
295-
}
296-
```
297-
298-
#### STDIO Proxy
299-
300-
Some clients don't support SSE and can instead interface with the MCP server over a STDIO proxy.
301-
302-
```json
303-
{
304-
"mcpServers": {
305-
"Bucket": {
306-
"command": "npx",
307-
"args": ["-y", "supergateway", "--sse", "http://localhost:8050/sse"]
308-
}
309-
}
310-
}
311-
```
312-
313-
### Cursor IDE
314-
315-
To enable MCP features in [Cursor IDE](https://www.cursor.com/):
316-
317-
1. Open Cursor IDE.
318-
2. Go to `Settings > MCP`.
319-
3. Click `Add new global MCP server` and paste the `SSE` config.
320-
4. Save and go back to Cursor.
283+
- `--app-id`: App ID to use for the MCP connection.
284+
- `--editor`: The editor/client to configure:
285+
- `cursor`: [Cursor IDE](https://www.cursor.com/)
286+
- `vscode`: [Visual Studio Code](https://code.visualstudio.com/)
287+
- `claude`: [Claude Desktop](https://claude.ai/download)
288+
- `windsurf`: [Windsurf](https://windsurf.com/editor)
289+
- `--scope`: Whether to configure settings globally or locally for the project.
321290

322-
### Claude Desktop
291+
The command will guide you through:
323292

324-
To enable MCP features in [Claude Desktop](https://claude.ai/download):
293+
1. Selecting which editor/client to configure.
294+
2. Choosing which Bucket app to connect to.
295+
3. Deciding between global or project-local configuration.
296+
4. Setting up the appropriate configuration file for your chosen editor .
325297

326-
1. Open Claude Desktop.
327-
2. Go to `Settings > Developer`.
328-
3. Click `Edit config` and paste the `STDIO` config.
329-
4. Save and restart Claude Desktop.
298+
_**Note: The setup uses [mcp-remote](https://github.com/geelen/mcp-remote) as a compatibility layer allowing the remote hosted Bucket MCP server to work with all editors/clients that support MCP STDIO servers. If your editor/client supports HTTP Streaming with OAuth you can connect to the Bucket MCP server directly.**_
330299

331300
## Development
332301

0 commit comments

Comments
 (0)