Cli

🚀 Smithery CLI

Smithery CLI 是一款用於 Model Context Protocol (MCP) 服務器的註冊表安裝程序和管理器，它在設計上與客戶端無關，能為用戶提供便捷的 MCP 服務器管理體驗。

🚀 快速開始

要求

• NodeJS 版本要求：18 或更高

基本使用

npx @smithery/cli <command>

✨ 主要特性

• 支持多種命令，涵蓋安裝、卸載、檢查、運行服務器等操作。
• 可指定 AI 客戶端，滿足不同客戶端的使用需求。
• 能提供 JSON 格式的配置數據，跳過提示步驟。
• 支持詳細日誌顯示，方便調試。

📦 安裝指南

無需額外安裝步驟，直接使用 npx 命令調用即可。

💻 使用示例

基礎用法

# 安裝一個服務器（需要 --client 標誌）
npx @smithery/cli install mcp-obsidian --client claude

# 列出可用客戶端
npx @smithery/cli list clients

高級用法

# 使用預配置數據安裝一個服務器（跳過提示）
npx @smithery/cli install mcp-obsidian --client claude --config '{"vaultPath":"path/to/vault"}'

# 使用配置運行服務器
npx @smithery/cli run mcp-obsidian --config '"{\\"key\\":\\"value\\"}"'

可用命令

重要注意事項

⚠️ 重要提示

• 安裝或卸載服務器後請記得重新啟動 AI 客戶端。
• 使用 inspect 命令進行交互式服務器測試。
• 不帶參數運行以顯示幫助菜單。
• 使用 --verbose 標誌查看更多調試信息。

📚 詳細文檔

開發指南

本指南將幫助您開始 @smithery/cli 的開發。

入門

1. 克隆倉庫：

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

2. 安裝依賴項：

   npm install
   

3. 構建項目：

   npm run build
   

開發命令

# 列出所有服務器
npx . list servers

# 檢查特定服務器
npx . inspect <server-id>

# 安裝一個服務器
npx . install <server-name> --client <client-name>

# 使用詳細日誌運行
npx . <command> --verbose

🤝 貢獻

歡迎貢獻！請隨時提交 Pull Request。