Skip to content
This repository was archived by the owner on May 21, 2026. It is now read-only.

Commit 92fdef6

Browse files
committed
chore: update pnpm-lock.yaml and README for CLI enhancements
- Add new dependencies and update versions in pnpm-lock.yaml - Enhance README with detailed usage instructions for development and production modes - Introduce new commands for starting development and production servers - Improve clarity on project structure and command options
1 parent 704cbc1 commit 92fdef6

2 files changed

Lines changed: 142 additions & 6 deletions

File tree

packages/cli/README.md

Lines changed: 58 additions & 6 deletions
Original file line numberDiff line numberDiff line change
@@ -1,34 +1,86 @@
11
# @mcp-use/cli
22

3-
Build tool for MCP UI widgets.
3+
Build and development tool for MCP servers with UI widgets.
44

55
## Install
66

77
```bash
88
npm install -g @mcp-use/cli
9+
# or
10+
yarn global add @mcp-use/cli
11+
# or
12+
pnpm add -g @mcp-use/cli
913
```
1014

1115
## Usage
1216

17+
### Development Mode
18+
1319
```bash
14-
mcp-use build [-p <project-path>]
20+
mcp-use dev [options]
1521
```
1622

17-
Bundles all `.tsx` files from `resources/` into standalone HTML pages in `dist/resources/mcp-use/widgets/`.
23+
Runs development server with:
24+
- TypeScript compilation in watch mode
25+
- Widget build in watch mode
26+
- Server with auto-reload (via tsx)
27+
- **Auto-opens inspector in browser** when ready
28+
29+
Options:
30+
- `-p, --path <path>` - Project directory (default: current directory)
31+
- `--port <port>` - Server port (default: 3000)
32+
- `--no-open` - Don't auto-open inspector
33+
34+
### Production Build
35+
36+
```bash
37+
mcp-use build [options]
38+
```
39+
40+
Builds TypeScript and bundles all `.tsx` files from `resources/` into standalone HTML pages.
41+
42+
Options:
43+
- `-p, --path <path>` - Project directory (default: current directory)
1844

1945
Each widget gets:
2046
- Hashed bundle for caching
2147
- Standalone HTML file
2248
- All dependencies bundled
2349

24-
## Example
50+
### Production Start
51+
52+
```bash
53+
mcp-use start [options]
54+
```
55+
56+
Starts the production server from built files.
57+
58+
Options:
59+
- `-p, --path <path>` - Project directory (default: current directory)
60+
- `--port <port>` - Server port (default: 3000)
61+
62+
## Examples
2563

2664
```bash
27-
# Build widgets in current directory
65+
# Start development with auto-reload and inspector
66+
mcp-use dev
67+
68+
# Development on custom port
69+
mcp-use dev --port 8080
70+
71+
# Development without auto-opening inspector
72+
mcp-use dev --no-open
73+
74+
# Build for production
2875
mcp-use build
2976

30-
# Build widgets in specific path
77+
# Start production server
78+
mcp-use start
79+
80+
# All commands support custom project path
81+
mcp-use dev -p ./my-app
3182
mcp-use build -p ./my-app
83+
mcp-use start -p ./my-app
3284
```
3385

3486
## Project Structure

pnpm-lock.yaml

Lines changed: 84 additions & 0 deletions
Some generated files are not rendered by default. Learn more about customizing how changed files appear on GitHub.

0 commit comments

Comments
 (0)