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 许可证。