@smithery/cli 1.2.6 → 1.2.8
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 +33 -0
- package/dist/index.js +50 -50
- package/package.json +1 -1
package/README.md
CHANGED
|
@@ -23,6 +23,21 @@ npx @smithery/cli <command>
|
|
|
23
23
|
- `--config <json>` - Provide configuration for the server
|
|
24
24
|
- `list clients` - List available clients
|
|
25
25
|
- `list servers --client <name>` - List installed servers for specific AI client
|
|
26
|
+
- `login` - Login with an API key (interactive)
|
|
27
|
+
- `dev [entryFile]` - Start development server with hot-reload and tunnel
|
|
28
|
+
- `--port <port>` - Port to run the server on (default: 8181)
|
|
29
|
+
- `--key <apikey>` - Provide an API key
|
|
30
|
+
- `--no-open` - Don't automatically open the playground
|
|
31
|
+
- `--prompt <prompt>` - Initial message to start the playground with
|
|
32
|
+
- `-c, --config <path>` - Path to config file (default: auto-detect smithery.config.js)
|
|
33
|
+
- `build [entryFile]` - Build MCP server for production
|
|
34
|
+
- `-o, --out <outfile>` - Output file path (default: .smithery/index.cjs)
|
|
35
|
+
- `--transport <type>` - Transport type: shttp or stdio (default: shttp)
|
|
36
|
+
- `-c, --config <path>` - Path to config file (default: auto-detect smithery.config.js)
|
|
37
|
+
- `playground` - Open MCP playground in browser
|
|
38
|
+
- `--port <port>` - Port to expose (default: 3000)
|
|
39
|
+
- `--key <apikey>` - Provide an API key
|
|
40
|
+
- Can pass command after `--` separator
|
|
26
41
|
- `--help` - Show help message
|
|
27
42
|
- `--verbose` - Show detailed logs for debugging
|
|
28
43
|
|
|
@@ -50,6 +65,21 @@ npx @smithery/cli inspect mcp-obsidian
|
|
|
50
65
|
# Run a server with configuration
|
|
51
66
|
npx @smithery/cli run mcp-obsidian --config '{"key":"value"}'
|
|
52
67
|
|
|
68
|
+
# Login and set API key
|
|
69
|
+
npx @smithery/cli login
|
|
70
|
+
|
|
71
|
+
# Start development server with hot-reload
|
|
72
|
+
npx @smithery/cli dev
|
|
73
|
+
npx @smithery/cli dev server.ts --port 3000
|
|
74
|
+
|
|
75
|
+
# Build server for production
|
|
76
|
+
npx @smithery/cli build
|
|
77
|
+
npx @smithery/cli build server.ts --out dist/server.cjs --transport stdio
|
|
78
|
+
|
|
79
|
+
# Open playground in browser
|
|
80
|
+
npx @smithery/cli playground
|
|
81
|
+
npx @smithery/cli playground --port 3001 -- node dist/server.js
|
|
82
|
+
|
|
53
83
|
# Show help menu
|
|
54
84
|
npx @smithery/cli --help
|
|
55
85
|
|
|
@@ -59,10 +89,13 @@ npx @smithery/cli install mcp-obsidian --client claude --verbose
|
|
|
59
89
|
|
|
60
90
|
### Important Notes
|
|
61
91
|
|
|
92
|
+
- Use `login` command to set your Smithery API key (required for some operations)
|
|
62
93
|
- Remember to restart your AI client after installing or uninstalling servers
|
|
63
94
|
- Use the `inspect` command for interactive server testing
|
|
64
95
|
- Run without arguments to see the help menu
|
|
65
96
|
- Use `--verbose` flag for detailed logs when troubleshooting
|
|
97
|
+
- The `dev` command provides hot-reload for MCP server development
|
|
98
|
+
- Use `playground` to test your MCP servers in an interactive web interface
|
|
66
99
|
|
|
67
100
|
## Development
|
|
68
101
|
|