Smithery Registry OpenAPI Server

Smithery Registry OpenAPI 服务

此服务为 Smithery Registry API 提供 OpenAPI 接口，让你能够搜索 MCP 服务并获取其启动配置。

功能

• 使用高级筛选条件列出可用的 MCP 服务
• 获取详细的服务信息，包括连接配置
• 生成包含 Base64 编码配置的 WebSocket URL
• 通过 bearer token 进行身份验证
• 兼容 OpenAPI 工具和客户端

身份验证

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

• 你需要在 Authorization 标头中提供 bearer token
• 格式：Authorization: Bearer your-api-token
• 在 Smithery 用户个人资料的 API keys 下获取 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": {
         // 与服务的架构匹配的配置对象
       }
     }
     

WebSocket 连接

直接连接到 MCP 服务的 WebSocket：

• URL 格式：https://server.smithery.ai/${qualifiedName}/ws?config=${base64encode(config)}
• 配置必须符合服务的 configSchema
• 配置为经过 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",
  {
    // config object matching schema
  },
)
const transport = new WebSocketClientTransport(url)

许可证

MIT