@smithery/cli 1.1.23 → 1.1.25
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 +20 -25
- package/dist/index.js +73 -90
- package/package.json +1 -1
package/README.md
CHANGED
|
@@ -1,4 +1,4 @@
|
|
|
1
|
-
# Smithery CLI 
|
|
1
|
+
# Smithery CLI  
|
|
2
2
|
|
|
3
3
|
The Smithery registry installer and manager for Model Context Protocol (MCP) servers, designed to be client-agnostic.
|
|
4
4
|
|
|
@@ -13,38 +13,33 @@ npx @smithery/cli <command>
|
|
|
13
13
|
|
|
14
14
|
### Available Commands
|
|
15
15
|
|
|
16
|
-
- `
|
|
17
|
-
-
|
|
18
|
-
|
|
19
|
-
-
|
|
20
|
-
- `
|
|
21
|
-
- `
|
|
16
|
+
- `install <package>` - Install a package
|
|
17
|
+
- `--client <name>` - Specify the AI client
|
|
18
|
+
- `uninstall <package>` - Uninstall a package
|
|
19
|
+
- `--client <name>` - Specify the AI client
|
|
20
|
+
- `inspect <server-id>` - Inspect a server interactively
|
|
21
|
+
- `run <server-id>` - Run a server
|
|
22
|
+
- `--config <json>` - Provide configuration for the server
|
|
22
23
|
|
|
23
24
|
### Examples
|
|
24
25
|
|
|
25
26
|
```bash
|
|
26
|
-
#
|
|
27
|
-
npx @smithery/cli installed
|
|
28
|
-
|
|
29
|
-
# Install a server (defaults to --client claude)
|
|
30
|
-
npx @smithery/cli install mcp-obsidian
|
|
31
|
-
|
|
32
|
-
# Install for specific client
|
|
27
|
+
# Install a server (requires --client flag)
|
|
33
28
|
npx @smithery/cli install mcp-obsidian --client claude
|
|
34
29
|
|
|
35
|
-
# View server details
|
|
36
|
-
npx @smithery/cli view mcp-obsidian
|
|
37
|
-
|
|
38
30
|
# Remove a server
|
|
39
|
-
npx @smithery/cli uninstall mcp-obsidian
|
|
31
|
+
npx @smithery/cli uninstall mcp-obsidian --client claude
|
|
32
|
+
|
|
33
|
+
# Inpsect a specific server from smithery's registry
|
|
34
|
+
npx @smithery/cli inspect mcp-obsidian
|
|
40
35
|
|
|
41
|
-
#
|
|
42
|
-
npx @smithery/cli
|
|
36
|
+
# Run a server with configuration
|
|
37
|
+
npx @smithery/cli run mcp-obsidian --config '"{\\"key\\":\\"value\\"}"'
|
|
43
38
|
```
|
|
44
39
|
|
|
45
40
|
### Important Notes
|
|
46
41
|
|
|
47
|
-
- Remember to restart
|
|
42
|
+
- Remember to restart your AI client after installing or uninstalling servers
|
|
48
43
|
- Use the `inspect` command for interactive server testing
|
|
49
44
|
- Run without arguments to see the help menu
|
|
50
45
|
|
|
@@ -74,13 +69,13 @@ This guide will help you get started with developing for @smithery/cli.
|
|
|
74
69
|
|
|
75
70
|
```bash
|
|
76
71
|
# List all servers
|
|
77
|
-
npx .
|
|
72
|
+
npx . <command>
|
|
78
73
|
|
|
79
|
-
#
|
|
80
|
-
npx .
|
|
74
|
+
# Inspect a specific server
|
|
75
|
+
npx . inspect <server-id>
|
|
81
76
|
|
|
82
77
|
# Install a server
|
|
83
|
-
npx . install <server-name>
|
|
78
|
+
npx . install <server-name> --client <client-name>
|
|
84
79
|
```
|
|
85
80
|
|
|
86
81
|
## Contributing
|