@smithery/cli 3.6.0 → 3.8.0

package/README.md

@@ -1,170 +1,84 @@
 # Smithery CLI [![NPM Version](https://img.shields.io/npm/v/%40smithery%2Fcli)](https://www.npmjs.com/package/@smithery/cli) [![NPM Downloads](https://img.shields.io/npm/dt/%40smithery%2Fcli)](https://www.npmjs.com/package/@smithery/cli)
 
-The Smithery registry installer and manager for Model Context Protocol (MCP) servers, designed to be client-agnostic.
-
-## Requirements
-- NodeJS version 20 or above
+CLI for installing MCP servers and managing cloud connections via [Smithery](https://smithery.ai).
 
 ## Installation
 
-Install globally for easier usage:
-
 ```bash
 npm install -g @smithery/cli
 ```
 
-## Usage
+Requires Node.js 20+.
 
-```bash
-smithery <command>
-```
+## Commands
 
-Or run directly without installation:
+### Local Server Management
 
 ```bash
-npx @smithery/cli <command>
+smithery install <server>     # Install a server to an AI client
+smithery uninstall <server>   # Remove a server
+smithery list                 # List installed servers
+smithery search [term]        # Search the Smithery registry
+smithery inspect <server>     # Interactive server testing
+smithery run <server>         # Run a server locally
 ```
 
-### Available Commands
-
-- `install <server>` - Install a server (interactive client selection)
-  - `--client <name>` - Specify the AI client (skips selection)
-  - `--config <json>` - Provide configuration data as JSON (skips prompts)
-- `uninstall <server>` - Uninstall a server (interactive client selection)
-  - `--client <name>` - Specify the AI client (skips selection)
-- `inspect <server-id>` - Inspect a server interactively
-- `run <server-id>` - Run a server
-  - `--config <json>` - Provide configuration for the server
-- `list` - List installed servers (interactive client selection)
-  - `--client <name>` - Specify the AI client (skips selection)
-- `search [term]` - Search for servers in the Smithery registry (interactive)
-- `login` - Login with an API key (interactive)
-- `dev [entryFile]` - Start development server with hot-reload and tunnel
-  - `--port <port>` - Port to run the server on (default: 8081)
-  - `--key <apikey>` - Provide an API key
-  - `--no-open` - Don't automatically open the playground
-  - `--prompt <prompt>` - Initial message to start the playground with
-  - `-c, --config <path>` - Path to config file (default: auto-detect smithery.config.js)
-- `build [entryFile]` - Build MCP server for production
-  - `-o, --out <outfile>` - Output file path (default: .smithery/index.cjs)
-  - `--transport <type>` - Transport type: shttp or stdio (default: shttp)
-  - `-c, --config <path>` - Path to config file (default: auto-detect smithery.config.js)
-- `playground` - Open MCP playground in browser
-  - `--port <port>` - Port to expose (default: 8081)
-  - `--key <apikey>` - Provide an API key
-  - Can pass command after `--` separator
-- `--help` - Show help message
-- `--verbose` - Show detailed logs for debugging
-
-### Examples
-
-```bash
-# Install a server (interactive client selection)
-smithery install exa
-
-# Install a server for specific client (skips selection)
-smithery install exa --client claude
-
-# Install a server with pre-configured data (skips prompts)
-smithery install exa --client claude --config '{"exaApiKey":"you_api_key"}'
+Options: `--client <name>` to skip client selection, `--config <json>` to provide configuration.
 
-# Remove a server (interactive client selection)
-smithery uninstall exa
+### Smithery Connect (Cloud MCP)
 
-# Remove a server from specific client (skips selection)
-smithery uninstall exa --client claude
+Manage cloud-hosted MCP servers via [Smithery Connect](https://smithery.ai).
 
-# List installed servers (interactive)
-smithery list
-
-# List installed servers for claude
-smithery list --client claude
+```bash
+# Namespace context (auto-created on first use)
+smithery namespace list       # List namespaces
+smithery namespace use <name> # Set current namespace
+smithery namespace show       # Show current namespace
+
+# Server connections
+smithery connect add <url>    # Add MCP server (--name for display name)
+smithery connect list         # List connected servers
+smithery connect remove <id>  # Remove a connection
+
+# Tools
+smithery connect tools [server]     # List tools (all or for specific server)
+smithery connect search <query>     # Fuzzy search tools by intent
+smithery connect call <id> [args]   # Call a tool (format: server/tool-name)
+```
 
-# Search for servers in the registry
-smithery search "web search"
+### Development
 
-# Search interactively (prompts for term)
-smithery search
+```bash
+smithery login                # Set API key
+smithery dev [entry]          # Dev server with hot-reload and tunnel
+smithery build [entry]        # Build for production
+smithery playground           # Open interactive testing UI
+```
 
-# Inspect a specific server from smithery's registry
-smithery inspect exa
+## Examples
 
-# Run a server with configuration
-smithery run exa --config '{"key":"value"}'
+```bash
+# Install a server
+smithery install exa --client claude --config '{"exaApiKey":"xxx"}'
 
-# Login and set API key
-smithery login
+# Cloud MCP workflow
+smithery connect add https://server.smithery.ai/github
+smithery connect search "create issue"
+smithery connect call github/create_issue '{"title":"Bug fix","body":"..."}'
 
-# Start development server with hot-reload
-smithery dev
+# Development
 smithery dev server.ts --port 3000
-
-# Build server for production
-smithery build
-smithery build server.ts --out dist/server.cjs --transport stdio
-
-# Open playground in browser
-smithery playground
-smithery playground --port 3001 -- node dist/server.js
-
-# Show help menu
-smithery --help
-
-# Install with verbose logging for debugging
-smithery install mcp-obsidian --client claude --verbose
+smithery build --out dist/server.cjs
 ```
 
-### Important Notes
-
-- Use `login` command to set your Smithery API key (required for some operations)
-- Remember to restart your AI client after installing or uninstalling servers
-- Use the `inspect` command for interactive server testing
-- Run without arguments to see the help menu
-- Use `--verbose` flag for detailed logs when troubleshooting
-- The `dev` command provides hot-reload for MCP server development
-- Use `playground` to test your MCP servers in an interactive web interface
-
 ## Development
 
-This guide will help you get started with developing for @smithery/cli.
-
-### Getting Started
-
-1. Clone the repository:
-   ```bash
-   git clone https://github.com/smithery-ai/cli
-   cd cli
-   ```
-
-2. Install dependencies:
-   ```bash
-   npm install
-   ```
-
-3. Build the project:
-   ```bash
-   npm run build
-   ```
-
-### Development Commands
-
 ```bash
-# List installed servers
-npx . list --client claude
-
-# Search for servers
-npx . search obsidian
-
-# Inspect a specific server
-npx . inspect <server-id>
-
-# Install a server
-npx . install <server-name> --client <client-name>
-
-# Run with verbose logging
-npx . <command> --verbose
+git clone https://github.com/smithery-ai/cli
+cd cli && npm install && npm run build
+npx . --help
 ```
 
 ## Contributing
 
-Contributions are welcome! Please feel free to submit a Pull Request.
+Contributions welcome! Please submit a Pull Request.