Smithery Openapi Server

🚀 史密瑟裡Registry OpenAPI 服務器

此服務器為史密瑟裡註冊表 API 提供了一個 OpenAPI 接口，藉助該接口，您能夠搜索並獲取模型上下文協議 (MCP) 服務器的啟動配置，為相關操作提供了便利。

✨ 主要特性

• 可列出可用的 MCP 服務器，並且具備高級過濾功能，方便您精準篩選所需服務器。
• 能夠獲取特定服務器的詳細信息，其中包括連接配置，讓您全面瞭解服務器情況。
• 可以生成包含 base64 編碼配置的 WebSocket URL，便於進行相關連接操作。
• 通過 bearer token 進行身份驗證，保障系統的安全性。
• 與 OpenAPI 工具和客戶端兼容，方便與其他系統集成。

📦 安裝指南

pip install -r requirements.txt

💻 使用示例

運行服務器

uvicorn main:app --host 0.0.0.0 --port 8000 --reload

API 端點

基礎用法

• GET /servers - 列出可用的 MCP 服務器
  • 查詢參數：
    • q: 搜索查詢（語義搜索）
    • page: 頁面編號（默認：1）
    • pageSize: 每頁項目數（默認：10）
  • 在 q 參數中使用高級過濾語法：
    • 文本搜索： "machine learning"
    • 所有者過濾：owner:username
    • 倉庫過濾：repo:repository-name
    • 部署狀態：is:deployed
    • 示例： "owner:smithery-ai repo:fetch is:deployed machine learning"

高級用法

• GET /servers/{qualified_name} - 獲取特定服務器的詳細信息
• POST /create-websocket-url - 創建包含編碼配置的 WebSocket URL
  • 請求正文：

  {
    "qualifiedName": "username/repository",
    "config": {
      // 符合該服務器模式的配置對象
    }
  }
  

WebSocket 連接

直接連接到 MCP 服務器的 WebSocket：

• URL 格式：https://server.smithery.ai/${qualifiedName}/ws?config=${base64encode(config)}
• 配置必須符合服務器的 configSchema
• 配置是 base64 編碼的 JSON

TypeScript SDK 使用

用於與史密瑟裡 TypeScript SDK 一起使用：

import { WebSocketClientTransport } from "@modelcontextprotocol/sdk/client/websocket.js"
import { createSmitheryUrl } from "@smithery/sdk/config.js"

const url = createSmitheryUrl(
  "https://your-smithery-mcp-server/ws",
  {
    // 配置對象符合模式
  },
)
const transport = new WebSocketClientTransport(url)

📚 詳細文檔

與 OpenAPI 工具集成

此服務器設計為與任何 OpenAPI 兼容的工具和框架兼容。API 遵循 RESTful 約法，並在運行時提供詳細的 OpenAPI 文檔，訪問 /docs 端點即可查看。

📄 許可證

本項目採用 MIT 許可證。