@smithery/cli 0.0.14 → 0.0.16
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 +72 -15
- package/dist/index.js +9 -9
- package/package.json +1 -1
package/README.md
CHANGED
|
@@ -2,33 +2,86 @@
|
|
|
2
2
|
|
|
3
3
|
A lightweight registry and package manager for Model Context Protocol (MCP) servers, designed to be client-agnostic.
|
|
4
4
|
|
|
5
|
+
## Installation
|
|
6
|
+
|
|
7
|
+
```bash
|
|
8
|
+
npm install -g @smithery/cli
|
|
9
|
+
```
|
|
10
|
+
|
|
11
|
+
## Usage
|
|
12
|
+
|
|
13
|
+
```bash
|
|
14
|
+
npx @smithery/cli <command>
|
|
15
|
+
```
|
|
16
|
+
|
|
17
|
+
### Available Commands
|
|
18
|
+
|
|
19
|
+
- `list` - Browse and search available packages
|
|
20
|
+
- `install <pkg>` - Install a package
|
|
21
|
+
- `--client <name>` - Specify AI client (e.g. claude)
|
|
22
|
+
- `uninstall <pkg>` - Remove an installed package
|
|
23
|
+
- `installed` - View installed packages
|
|
24
|
+
- `get <pkg>` - Show package details
|
|
25
|
+
- `inspect` - Inspect available servers and primitives
|
|
26
|
+
|
|
27
|
+
### Examples
|
|
28
|
+
|
|
29
|
+
```bash
|
|
30
|
+
# Browse available packages
|
|
31
|
+
npx @smithery/cli list
|
|
32
|
+
|
|
33
|
+
# Install a package (defaults to --client claude)
|
|
34
|
+
npx @smithery/cli install mcp-obsidian
|
|
35
|
+
|
|
36
|
+
# Install for specific client
|
|
37
|
+
npx @smithery/cli install mcp-obsidian --client claude
|
|
38
|
+
|
|
39
|
+
# View installed packages
|
|
40
|
+
npx @smithery/cli installed
|
|
41
|
+
|
|
42
|
+
# Remove a package
|
|
43
|
+
npx @smithery/cli uninstall mcp-obsidian
|
|
44
|
+
|
|
45
|
+
# Get package details
|
|
46
|
+
npx @smithery/cli get mcp-obsidian
|
|
47
|
+
|
|
48
|
+
# Inspect servers
|
|
49
|
+
npx @smithery/cli inspect
|
|
50
|
+
```
|
|
51
|
+
|
|
52
|
+
### Important Notes
|
|
53
|
+
|
|
54
|
+
- When installing unverified packages, you'll be prompted to:
|
|
55
|
+
1. Confirm installation
|
|
56
|
+
2. Select runtime (Node.js/Python)
|
|
57
|
+
- Remember to restart Claude after uninstalling packages
|
|
58
|
+
- Use the `inspect` command for interactive server testing
|
|
59
|
+
- Run without arguments to see the help menu
|
|
60
|
+
|
|
5
61
|
## Development
|
|
6
62
|
|
|
7
63
|
This guide will help you get started with developing for @smithery/cli.
|
|
8
64
|
|
|
9
65
|
### Getting Started
|
|
10
66
|
|
|
11
|
-
#### Initial Setup
|
|
12
|
-
|
|
13
67
|
1. Clone the repository:
|
|
14
|
-
```bash
|
|
15
|
-
git clone git@github.com:smithery-ai/cli.git
|
|
16
|
-
cd cli
|
|
17
|
-
```
|
|
68
|
+
```bash
|
|
69
|
+
git clone git@github.com:smithery-ai/cli.git
|
|
70
|
+
cd cli
|
|
71
|
+
```
|
|
18
72
|
|
|
19
73
|
2. Install dependencies:
|
|
20
|
-
```bash
|
|
21
|
-
npm install
|
|
22
|
-
```
|
|
74
|
+
```bash
|
|
75
|
+
npm install
|
|
76
|
+
```
|
|
23
77
|
|
|
24
78
|
3. Build the project:
|
|
25
|
-
```bash
|
|
26
|
-
npm run build
|
|
27
|
-
```
|
|
79
|
+
```bash
|
|
80
|
+
npm run build
|
|
81
|
+
```
|
|
28
82
|
|
|
29
|
-
###
|
|
83
|
+
### Development Commands
|
|
30
84
|
|
|
31
|
-
Test specific functionality:
|
|
32
85
|
```bash
|
|
33
86
|
# List all packages
|
|
34
87
|
npx . list
|
|
@@ -38,4 +91,8 @@ npx . get <package-id>
|
|
|
38
91
|
|
|
39
92
|
# Install a package
|
|
40
93
|
npx . install <package-name>
|
|
41
|
-
```
|
|
94
|
+
```
|
|
95
|
+
|
|
96
|
+
## Contributing
|
|
97
|
+
|
|
98
|
+
Contributions are welcome! Please feel free to submit a Pull Request.
|