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

Commit 32292bb

Browse files
committed
chore: info about CLI
1 parent 57a09b0 commit 32292bb

3 files changed

Lines changed: 101 additions & 1 deletion

File tree

packages/cli/LICENSE

Lines changed: 22 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,22 @@
1+
MIT License
2+
3+
Copyright (c) 2025 mcp-use, Inc.
4+
5+
Permission is hereby granted, free of charge, to any person obtaining a copy
6+
of this software and associated documentation files (the "Software"), to deal
7+
in the Software without restriction, including without limitation the rights
8+
to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
9+
copies of the Software, and to permit persons to whom the Software is
10+
furnished to do so, subject to the following conditions:
11+
12+
The above copyright notice and this permission notice shall be included in all
13+
copies or substantial portions of the Software.
14+
15+
THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
16+
IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
17+
FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
18+
AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
19+
LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
20+
OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
21+
SOFTWARE.
22+

packages/cli/README.md

Lines changed: 52 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,52 @@
1+
# @mcp-use/cli
2+
3+
Build tool for MCP UI widgets.
4+
5+
## Install
6+
7+
```bash
8+
npm install -g @mcp-use/cli
9+
```
10+
11+
## Usage
12+
13+
```bash
14+
mcp-use build [-p <project-path>]
15+
```
16+
17+
Bundles all `.tsx` files from `resources/` into standalone HTML pages in `dist/resources/mcp-use/widgets/`.
18+
19+
Each widget gets:
20+
- Hashed bundle for caching
21+
- Standalone HTML file
22+
- All dependencies bundled
23+
24+
## Example
25+
26+
```bash
27+
# Build widgets in current directory
28+
mcp-use build
29+
30+
# Build widgets in specific path
31+
mcp-use build -p ./my-app
32+
```
33+
34+
## Project Structure
35+
36+
```
37+
my-app/
38+
├── resources/
39+
│ ├── todo-list.tsx
40+
│ └── kanban-board.tsx
41+
└── dist/
42+
└── resources/
43+
└── mcp-use/
44+
└── widgets/
45+
├── todo-list/
46+
│ ├── index.html
47+
│ └── assets/
48+
└── kanban-board/
49+
├── index.html
50+
└── assets/
51+
```
52+

packages/cli/package.json

Lines changed: 27 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1,10 +1,36 @@
11
{
22
"name": "@mcp-use/cli",
33
"version": "2.0.0",
4-
"description": "MCP CLI package",
4+
"description": "Build tool for MCP UI widgets - bundles React components into standalone HTML pages for Model Context Protocol servers",
5+
"author": "mcp-use, Inc.",
6+
"license": "MIT",
7+
"homepage": "https://github.com/mcp-use/mcp-use-ts#readme",
8+
"repository": {
9+
"type": "git",
10+
"url": "git+https://github.com/mcp-use/mcp-use-ts.git",
11+
"directory": "packages/cli"
12+
},
13+
"bugs": {
14+
"url": "https://github.com/mcp-use/mcp-use-ts/issues"
15+
},
16+
"keywords": [
17+
"mcp",
18+
"model-context-protocol",
19+
"cli",
20+
"build-tool",
21+
"widget",
22+
"ui",
23+
"react",
24+
"esbuild",
25+
"bundler",
26+
"typescript"
27+
],
528
"bin": {
629
"mcp-use": "./dist/index.js"
730
},
31+
"files": [
32+
"dist"
33+
],
834
"scripts": {
935
"build": "tsc",
1036
"dev": "tsc --watch",

0 commit comments

Comments
 (0)