@ubuligan/create-mcp-app 0.1.0 → 0.1.1
This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
- package/README.md +51 -0
- package/package.json +1 -1
package/README.md
ADDED
|
@@ -0,0 +1,51 @@
|
|
|
1
|
+
# @ubuligan/create-mcp-app
|
|
2
|
+
|
|
3
|
+
Scaffold a **working MCP project** — server, client, or both — in seconds. TypeScript, ESM, with
|
|
4
|
+
stdio and/or Streamable HTTP transports wired up and a runnable demo.
|
|
5
|
+
|
|
6
|
+
Part of the [MCP Toolkit](https://github.com/jsznpm/create-mcp-toolkit).
|
|
7
|
+
|
|
8
|
+
## Usage
|
|
9
|
+
|
|
10
|
+
```bash
|
|
11
|
+
npm create @ubuligan/mcp-app@latest my-mcp-app
|
|
12
|
+
# or
|
|
13
|
+
npx @ubuligan/create-mcp-app my-mcp-app
|
|
14
|
+
```
|
|
15
|
+
|
|
16
|
+
Run with no flags for an interactive wizard, or pass flags to skip the prompts:
|
|
17
|
+
|
|
18
|
+
```bash
|
|
19
|
+
npx @ubuligan/create-mcp-app my-server \
|
|
20
|
+
--template server \
|
|
21
|
+
--transport both \
|
|
22
|
+
--features tools,resources,prompts \
|
|
23
|
+
--yes
|
|
24
|
+
```
|
|
25
|
+
|
|
26
|
+
| Flag | Values | Default |
|
|
27
|
+
| --- | --- | --- |
|
|
28
|
+
| `[dir]` | target directory | prompted (`my-mcp-app`) |
|
|
29
|
+
| `-t, --template` | `server` \| `client` \| `both` | prompted (`both`) |
|
|
30
|
+
| `--transport` | `stdio` \| `http` \| `both` | prompted (`both`) |
|
|
31
|
+
| `--features` | comma list: `tools,resources,prompts` | prompted (all) |
|
|
32
|
+
| `-y, --yes` | skip all prompts, use defaults | off |
|
|
33
|
+
|
|
34
|
+
## What you get
|
|
35
|
+
|
|
36
|
+
A ready-to-run project:
|
|
37
|
+
|
|
38
|
+
```bash
|
|
39
|
+
cd my-mcp-app
|
|
40
|
+
npm install
|
|
41
|
+
npm run build
|
|
42
|
+
npm start # or: npm run demo:client (for the "both" template)
|
|
43
|
+
```
|
|
44
|
+
|
|
45
|
+
The generated server uses [`@ubuligan/server`](https://www.npmjs.com/package/@ubuligan/server) and
|
|
46
|
+
the client uses [`@ubuligan/client`](https://www.npmjs.com/package/@ubuligan/client), so you start
|
|
47
|
+
with the same ergonomic toolkit, not raw SDK boilerplate.
|
|
48
|
+
|
|
49
|
+
## License
|
|
50
|
+
|
|
51
|
+
MIT
|