Smithery Registry OpenAPI 服务器

此服务器提供了一个 OpenAPI 接口，用于访问 Smithery Registry API，允许您搜索和获取模型上下文协议 (MCP) 服务器的启动配置。

功能

• 列出可用的 MCP 服务器，并提供高级筛选功能
• 获取详细的服务器信息，包括连接配置
• 生成带有 base64 编码配置的 WebSocket URL
• 通过 bearer token 进行身份验证
• 兼容 OpenAPI 工具和客户端

身份验证

所有对 Smithery Registry API 的请求都需要身份验证：

• 您需要在 Authorization 标头中提供 bearer token
• 格式：Authorization: Bearer your-api-token
• 从您的 Smithery 用户个人资料中的 API 密钥下获取 token

用法

安装

pip install -r requirements.txt

运行服务器

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

API 接口

1. 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"

2. GET /servers/{qualified_name} - 获取有关特定服务器的详细信息

3. POST /create-websocket-url - 创建带有编码配置的 WebSocket URL

   • 请求体：

     {
       "qualifiedName": "username/repository",
       "config": {
         // 与服务器 schema 匹配的配置对象
       }
     }
     

WebSocket 连接

对于直接连接到 MCP 服务器的 WebSocket 连接：

• URL 格式：https://server.smithery.ai/${qualifiedName}/ws?config=${base64encode(config)}
• Config 必须符合服务器的 configSchema
• Config 是 base64 编码的 JSON

与 OpenAPI 工具集成

此服务器旨在与任何符合 OpenAPI 标准的工具和框架兼容。 该 API 遵循 RESTful 约定，并在运行时在 /docs 接口提供详细的 OpenAPI 文档。

TypeScript SDK 用法

与 Smithery 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",
  {
    // 与 schema 匹配的配置对象
  },
)
const transport = new WebSocketClientTransport(url)

许可证

MIT