@smithery/cli 1.2.24 → 1.2.26
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 +57 -27
- package/dist/index.js +5923 -34015
- package/package.json +2 -1
package/README.md
CHANGED
|
@@ -5,24 +5,39 @@ The Smithery registry installer and manager for Model Context Protocol (MCP) ser
|
|
|
5
5
|
## Requirements
|
|
6
6
|
- NodeJS version 18 or above
|
|
7
7
|
|
|
8
|
+
## Installation
|
|
9
|
+
|
|
10
|
+
Install globally for easier usage:
|
|
11
|
+
|
|
12
|
+
```bash
|
|
13
|
+
npm install -g @smithery/cli
|
|
14
|
+
```
|
|
15
|
+
|
|
8
16
|
## Usage
|
|
9
17
|
|
|
18
|
+
```bash
|
|
19
|
+
smithery <command>
|
|
20
|
+
```
|
|
21
|
+
|
|
22
|
+
Or run directly without installation:
|
|
23
|
+
|
|
10
24
|
```bash
|
|
11
25
|
npx @smithery/cli <command>
|
|
12
26
|
```
|
|
13
27
|
|
|
14
28
|
### Available Commands
|
|
15
29
|
|
|
16
|
-
- `install <
|
|
17
|
-
- `--client <name>` - Specify the AI client
|
|
30
|
+
- `install <server>` - Install a server (interactive client selection)
|
|
31
|
+
- `--client <name>` - Specify the AI client (skips selection)
|
|
18
32
|
- `--config <json>` - Provide configuration data as JSON (skips prompts)
|
|
19
|
-
- `uninstall <
|
|
20
|
-
- `--client <name>` - Specify the AI client
|
|
33
|
+
- `uninstall <server>` - Uninstall a server (interactive client selection)
|
|
34
|
+
- `--client <name>` - Specify the AI client (skips selection)
|
|
21
35
|
- `inspect <server-id>` - Inspect a server interactively
|
|
22
36
|
- `run <server-id>` - Run a server
|
|
23
37
|
- `--config <json>` - Provide configuration for the server
|
|
24
|
-
- `list
|
|
25
|
-
-
|
|
38
|
+
- `list` - List installed servers (interactive client selection)
|
|
39
|
+
- `--client <name>` - Specify the AI client (skips selection)
|
|
40
|
+
- `search [term]` - Search for servers in the Smithery registry (interactive)
|
|
26
41
|
- `login` - Login with an API key (interactive)
|
|
27
42
|
- `dev [entryFile]` - Start development server with hot-reload and tunnel
|
|
28
43
|
- `--port <port>` - Port to run the server on (default: 8181)
|
|
@@ -44,47 +59,59 @@ npx @smithery/cli <command>
|
|
|
44
59
|
### Examples
|
|
45
60
|
|
|
46
61
|
```bash
|
|
47
|
-
# Install a server (
|
|
48
|
-
|
|
62
|
+
# Install a server (interactive client selection)
|
|
63
|
+
smithery install mcp-obsidian
|
|
64
|
+
|
|
65
|
+
# Install a server for specific client (skips selection)
|
|
66
|
+
smithery install mcp-obsidian --client claude
|
|
49
67
|
|
|
50
68
|
# Install a server with pre-configured data (skips prompts)
|
|
51
|
-
|
|
69
|
+
smithery install mcp-obsidian --client claude --config '{"vaultPath":"path/to/vault"}'
|
|
70
|
+
|
|
71
|
+
# Remove a server (interactive client selection)
|
|
72
|
+
smithery uninstall mcp-obsidian
|
|
52
73
|
|
|
53
|
-
# Remove a server
|
|
54
|
-
|
|
74
|
+
# Remove a server from specific client (skips selection)
|
|
75
|
+
smithery uninstall mcp-obsidian --client claude
|
|
55
76
|
|
|
56
|
-
# List
|
|
57
|
-
|
|
77
|
+
# List installed servers (interactive)
|
|
78
|
+
smithery list
|
|
58
79
|
|
|
59
80
|
# List installed servers for claude
|
|
60
|
-
|
|
81
|
+
smithery list --client claude
|
|
82
|
+
|
|
83
|
+
# Search for servers in the registry
|
|
84
|
+
smithery search obsidian
|
|
85
|
+
|
|
86
|
+
# Search interactively (prompts for term)
|
|
87
|
+
smithery search
|
|
61
88
|
|
|
62
89
|
# Inspect a specific server from smithery's registry
|
|
63
|
-
|
|
90
|
+
smithery inspect mcp-obsidian
|
|
64
91
|
|
|
65
92
|
# Run a server with configuration
|
|
66
|
-
|
|
93
|
+
smithery run mcp-obsidian --config '{"key":"value"}'
|
|
67
94
|
|
|
68
95
|
# Login and set API key
|
|
69
|
-
|
|
96
|
+
smithery login
|
|
70
97
|
|
|
71
98
|
# Start development server with hot-reload
|
|
72
|
-
|
|
73
|
-
|
|
99
|
+
smithery dev
|
|
100
|
+
smithery dev server.ts --port 3000
|
|
74
101
|
|
|
75
102
|
# Build server for production
|
|
76
|
-
|
|
77
|
-
|
|
103
|
+
smithery build
|
|
104
|
+
smithery build server.ts --out dist/server.cjs --transport stdio
|
|
78
105
|
|
|
79
106
|
# Open playground in browser
|
|
80
|
-
|
|
81
|
-
|
|
107
|
+
smithery playground
|
|
108
|
+
smithery playground --port 3001 -- node dist/server.js
|
|
82
109
|
|
|
83
110
|
# Show help menu
|
|
84
|
-
|
|
111
|
+
smithery --help
|
|
85
112
|
|
|
86
113
|
# Install with verbose logging for debugging
|
|
87
|
-
|
|
114
|
+
smithery install mcp-obsidian --client claude --verbose
|
|
88
115
|
```
|
|
89
116
|
|
|
90
117
|
### Important Notes
|
|
@@ -122,8 +149,11 @@ This guide will help you get started with developing for @smithery/cli.
|
|
|
122
149
|
### Development Commands
|
|
123
150
|
|
|
124
151
|
```bash
|
|
125
|
-
# List
|
|
126
|
-
npx . list
|
|
152
|
+
# List installed servers
|
|
153
|
+
npx . list --client claude
|
|
154
|
+
|
|
155
|
+
# Search for servers
|
|
156
|
+
npx . search obsidian
|
|
127
157
|
|
|
128
158
|
# Inspect a specific server
|
|
129
159
|
npx . inspect <server-id>
|