Cli

🚀 Smithery CLI

Smithery CLI is a registry installer and manager for Model Context Protocol (MCP) servers, designed to be client-agnostic. It simplifies the process of managing MCP servers and packages, offering a seamless experience for users.

🚀 Quick Start

Requirements

• NodeJS version 18 or higher

Usage

npx @smithery/cli <command>

Available Commands

• install <package> - Install a package
  • --client <name> - Specify the AI client
  • --config <json> - Provide configuration data in JSON format (skip prompts)
• uninstall <package> - Uninstall a package
  • --client <name> - Specify the AI client
• inspect <server-id> - Interactively inspect a server
• run <server-id> - Run a server
  • --config <json> - Provide server configuration
• list clients - List available clients
• list servers --client <name> - List installed servers for a specific AI client
• --help - Display help information
• --verbose - Show detailed logs for debugging

Examples

# Install a server (requires --client flag)
npx @smithery/cli install mcp-obsidian --client claude

# Install a server with pre-configured data (skip prompts)
npx @smithery/cli install mcp-obsidian --client claude --config '{"vaultPath":"path/to/vault"}'

# Uninstall a server
npx @smithery/cli uninstall mcp-obsidian --client claude

# List available clients
npx @smithery/cli list clients

# List installed servers for the claude client
npx @smithery/cli list servers --client claude

# Inspect a specific server in the registry
npx @smithery/cli inspect mcp-obsidian

# Run a server with configuration
npx @smithery/cli run mcp-obsidian --config '"{\\"key\\":\\"value\\"}"'

# Display the help menu
npx @smithery/cli --help

# Install with verbose logs for debugging
npx @smithery/cli install mcp-obsidian --client claude --verbose

Important Note

⚠️ Important Note

• Remember to restart the AI client after installing or uninstalling a server.
• Use the inspect command for interactive server testing.
• Run without arguments to display the help menu.
• Use the --verbose flag to view more debugging information.

📚 Documentation

Development Guide

This guide will help you get started with the development of @smithery/cli.

Getting Started

1. Clone the repository:

   git clone https://github.com/smithery-ai/cli
   cd cli
   

2. Install dependencies:

   npm install
   

3. Build the project:

   npm run build
   

Development Commands

# List all servers
npx . list servers

# Inspect a specific server
npx . inspect <server-id>

# Install a server
npx . install <server-name> --client <client-name>

# Run with verbose logs
npx . <command> --verbose

🤝 Contribution

Contributions are welcome! Please feel free to submit a Pull Request.