Sezzlee OpenAPI

io.github.sezzlee由 GitHub 账号 sezzlee 发布v1.0.0更新于 Oct 30, 2026

Expose an OpenAPI document to agents as a search-first tool catalog over your existing API.

已验证STDIO仅桌面开发者工具AI 与机器学习

概览

AI 生成的概览

把 OpenAPI(Swagger 2.0 / OpenAPI 3.0–3.2)文档转成以搜索为先的工具目录,让助手找到并调用你现有的 API 操作。

可以做什么
  • 搜索由 OpenAPI 文档生成的 API 操作目录
  • 加载某个操作作为工具,带上整理好的参数与说明
  • 通过网络调用后端操作并读取响应
  • 读取因超出大小限制而被暂存的结果
  • 按间隔或信号重新加载文档并刷新目录
适用场景
适用于后端已发布 OpenAPI 文档但没有集成嵌入式 SDK 的情况,希望助手通过受控目录而非直接发 HTTP 请求来发现和调用其操作。也适合需要在配置文件中定义暴露范围、命名和凭据规则的团队。
运行要求
通过 npm 包 @sezzlee/openapi-mcp 以 stdio 在本地运行(需要 Node.js,可用 npx 或全局安装)。需要设置环境变量 SEZZLEE_OPENAPI_CONFIG 指向 JSON 配置文件,其中指定 OpenAPI 来源(本地路径或 http(s) 地址)与选择规则。后端凭据在配置中以环境变量引用;需要能访问后端的网络。
安装前请注意
每次调用都会请求你的后端,并附带它从配置所指定环境变量中解析出的凭据,这些密钥会被代为使用。根据你暴露的操作,它可能写入、修改或删除数据,建议保持默认的按需选择并尽量收窄范围。未配置令牌交换的 http 传输只能绑定回环地址,调用方的 MCP 令牌不会转发给后端。可见性不等于权限控制:除非文档声明 security 为空,目录会把操作身份标为未知。

安装

在 SourceWeft 中

  1. 打开 控制台中的 Sezzlee OpenAPI,将其添加到工作区。
  2. 为需要使用其工具的对话启用该服务。

Desktop only,通过 STDIO。 STDIO 服务会启动本地进程,因此需要 SourceWeft 桌面宿主。

其他 MCP 客户端

参照 仓库 中的启动说明。

README

@sezzlee/openapi-mcp

MCP server that exposes an OpenAPI (Swagger 2.0 / OpenAPI 3.0–3.2) document as sezzlee's search-first tool catalog — search_tools, load_tool, invoke_tool, read_result — over a remote backend, calling it with fetch.

Status: 1.0.0, stable. Install with npm install -g @sezzlee/openapi-mcp or run it with npx -y @sezzlee/openapi-mcp; the binary is sezzlee-openapi.

How this differs from the embedded SDK

The NestJS SDK sits inside your backend process: it discovers endpoints from your own controllers/routes and replay each MCP call through your existing pipeline, so your authentication and authorization run exactly as they do today.

openapi-mcp is a separate service. It has no access to a backend's process or pipeline — it reads the backend's OpenAPI document to learn what operations exist (the ingestion rules), and calls the backend over the network for every invocation, attaching a credential it resolves itself (how a credential is chosen and written). This is the only path for a backend that has no embedded SDK integrated into it.

Everything an embedded SDK declares in code, a document declares in one x-sezzlee extension per operation, and a host that cannot edit the document declares under operations in this config: selection, tool name, prefix, behaviour hints, argument curation, variants, families, search terms and revisions (the x-sezzlee extension). A backend that routes many capabilities through one endpoint (POST /Rest/InvokeDynamicMethod/{methodId}) lists them in that operation's x-sezzlee.family; each member becomes its own tool, with its own name, description and body, and the dispatch key stays hidden.

Quick start

The server reads its configuration from the file named by SEZZLEE_OPENAPI_CONFIG. Build the package first (this repository never runs @sezzlee/core's consumers against a stale dist):

bash
pnpm turbo run build --filter=@sezzlee/openapi-mcp

A minimal config — a local document, opt-in selection so at least one operation is exposed, default stdio transport:

json
{  "source": "./openapi.json",  "selection": { "default": "include" }}
bash
SEZZLEE_OPENAPI_CONFIG=/absolute/path/to/config.json node packages/servers/openapi-mcp/dist/cli.js

source is either a path (resolved relative to the config file's own directory) or an http(s):// URL. On startup the server ingests the document, builds the catalog, prints a one-line-per-diagnostic-code summary to stderr, and then serves stdio or listens for streamable HTTP, depending on transport.kind.

A config that fails validation, or that names an environment variable that is not set, stops the process with a message on stderr and exit code 2. A document that ingests with a fatal diagnostic, or a catalog with a fatal diagnostic (name_collision, invalid_name, ambiguous_selection, …), stops it with exit code 1.

Configuration

All keys below are read from the SEZZLEE_OPENAPI_CONFIG JSON file and validated with a zod schema (src/platform/config.ts) that rejects unknown keys.

KeyTypeDefaultNotes
transport.kind"stdio" | "http""stdio"—
transport.hoststring (http only)"127.0.0.1"Must stay loopback (127.0.0.1, ::1, localhost) unless tokenExchange is configured — see below
transport.portint, 0–65535 (http only)8787—
transport.pathstring starting with / (http only)"/mcp"—
transport.resourceurl (http only)requiredThe OAuth protected-resource identifier advertised at /.well-known/oauth-protected-resource
transport.authorizationServersarray of url, min 1 (http only)required—
transport.allowedHostnamesarray of string (http only)[]Extra Host header values accepted, on top of the localhost defaults
tokenExchangeobjectnot configuredRFC 8693 token exchange; required for an http transport to authenticate a caller (see Rules)
tokenExchange.tokenEndpointurlrequired—
tokenExchange.clientIdstringrequired—
tokenExchange.clientSecret{ fromEnv: string }required—
tokenExchange.clientAuth"basic" | "post""basic"client_secret_basic or client_secret_post
tokenExchange.audiencestringnot sent—
tokenExchange.resourceurlnot sent—
tokenExchange.scopestringnot sent—
tokenExchange.schemesarray of string, min 1requiredThe security scheme names the exchanged token satisfies
sourcestring, non-emptyrequiredA local file path (relative to the config file) or an http(s):// URL to the OpenAPI document
reload.intervalSecondsinteger ≥ 10not setRe-reads source this often, plus up to 10% jitter. Conditional on the last ETag/Last-Modified for an http(s) source; a body identical to the served one is ignored
reload.onSignalbooleantrueSIGHUP re-reads source. Without a reload block the document is read once at startup and SIGHUP keeps its default action
baseUrlurlnot setReplaces the document's root servers
serverVariablesrecord<string, string>not setOverrides for the document's server variable defaults
hoistPathPrefixstring starting with /not setA leading path segment moved from every route into the base URL
outputSchema"document" | "omit""document"omit for a backend whose responses do not match its document
requestBodyRequired"document" | "always""document"always treats an undeclared requestBody.required as true
strictbooleanfalseRaises openapi_document_invalid from a warning to a fatal diagnostic
selection.default"include" | "exclude""exclude"Whether an operation is exposed when no rule matches it (opt-in by default)
selection.rulesarray of { route?, method?, decision }[]route/method are matched the same way the embedded SDKs match a controller route
operationsrecord<operation key, x-sezzlee object>{}Laid over each operation's x-sezzlee field by field; a key that names no operation is fatal. A field here may not also be set through names, searchTerms or revision.operations
namesrecord<operation key, string>{}Overrides a tool's name; the value must match ^[a-z][a-z0-9_]{0,255}$
revision.cataloginteger ≥ 1not configuredBehaviour revision of every tool; comes before the document root's x-sezzlee revision
revision.pathsrecord<document path, integer ≥ 1>{}Behaviour revision of every operation under that path item; comes before the path item's x-sezzlee revision
revision.operationsrecord<operation key, integer ≥ 1>{}Behaviour revision of one operation; comes before its x-sezzlee revision. The levels add up rather than replacing one another
credentialsrecord<security scheme name, credential>{}Either { "value": { "fromEnv": "..." } } or { "username": { "fromEnv": "..." }, "password": { "fromEnv": "..." } }; see credentials.md
allowHostsarray of string[]Hosts a backend operation may be served from, beyond the document's own root server
refHostsarray of string[]Hosts an external $ref may be fetched from, beyond the document's own host. Kept apart from allowHosts, so allowing a schema host never lets calls or credentials go there
identityCookiesarray of string[]Cookie names treated as identity carriers on top of the default deny-list (compared case-insensitively); they extend it and never replace it
limits.timeoutMspositive int30000Per-invocation deadline
limits.maxResponseBytespositive int262144The largest answer that reaches the agent; a larger success is stored for read_result while results.enabled holds, and refused otherwise
limits.maxBufferedBytespositive int16777216The largest backend body read, applied while the body streams; a larger one is refused unread
results.enabledbooleantrueKeeps over-budget successes in memory and publishes read_result; see result-reading.md
results.lifetimeMsint ≥ 1000600000How long a stored result is kept
results.maxCallerBytespositive int16777216What one caller's stored results may hold; the oldest go first. A caller is the bearer token it authenticated with, or every loopback caller when there is no token exchange
results.maxBytespositive int67108864What all stored results may hold; at least results.maxCallerBytes
limits.maxInlineFileBytespositive int1048576—

A credentials entry is keyed by the security scheme name it satisfies; a tokenExchange.schemes entry marks that same scheme as satisfied by the exchanged token instead. credentials values are never inlined — only a reference to an environment variable — so a config file can be committed and shared.

Rules

  • Only src/net/fetch.ts reaches the network. It is the one place the host allowlist, the manual redirect handling and the byte cap are applied; src/transport/http.ts may use node:http only to listen, never to call out. Redirects are never followed — a followed redirect could carry a request, and its credential, to a host the allowlist never approved.
  • Only src/platform/files.ts touches the filesystem. A file the document references through an external $ref, or named by source, is checked against the directory the document was read from on its realpath, so neither a ../ segment nor a symbolic link can escape it.
  • The caller's MCP token is never forwarded to the backend. Its audience is this server, not the backend; forwarding it would bypass the backend's own audience check. On the http transport with tokenExchange configured, the caller's token is exchanged (RFC 8693) for a backend-scoped token at the transport's bearer gate, and only the exchanged token reaches invoke_tool.
  • An http transport without tokenExchange authenticates no caller, so it may only bind a loopback host (127.0.0.1, ::1, localhost); otherwise the operator's static credentials would be reachable from the network. Configuring tokenExchange on the stdio transport is likewise refused (token_exchange_requires_http) — there is no caller token on stdio to exchange.
  • A reload never widens egress. reload re-reads only the document, never the config, and the hosts the first catalog may call are the ceiling for every later one: a document whose servers move to a host outside it, from https to plain http, or that sends a credential to a plain-http origin that did not carry it before, is refused (widens_egress). A refused document, one with a fatal diagnostic, or one that cannot be read keeps the running catalog. A committed reload advances the catalog generation stamped on every meta-tool and sends tools/list_changed. A tool loaded before a reload answers unknown_tool if it is gone and tool_changed to a call pinned to its old version.
  • Visibility is not enforcement: an operation's security says which credential a call needs, not which caller may make it, so the catalog reports every operation's identity as unknown unless its document says security: [].

Development

bash
pnpm turbo run build --filter=@sezzlee/openapi-mcppnpm turbo run lint --filter=@sezzlee/openapi-mcppnpm turbo run check-types --filter=@sezzlee/openapi-mcppnpm turbo run test --filter=@sezzlee/openapi-mcp

Run these through Turbo, not pnpm --filter @sezzlee/openapi-mcp <task> — the bare filter skips dependsOn: ["build"] and the test task would run against a stale dist.

test/ holds unit suites that need no environment variables, plus one gated suite:

  • acceptance.spec.ts — skipped unless SEZZLEE_OPENAPI_ACCEPTANCE_DOC names a path to a real backend's OpenAPI document. The document itself never enters the repository; the suite ingests it, builds a catalog, asserts there is no fatal diagnostic, and prints the diagnostic summary instead of pinning a snapshot that would copy that backend's surface into the tree. SEZZLEE_OPENAPI_ACCEPTANCE_DOC is declared in this package's turbo.json test task so Turbo passes it through.

来源:packages/servers/openapi-mcp/README.md,提交 0426373

工具

0
SourceWeft 尚未在沙箱中启动过该软件包,因此其工具未知。

版本历史

3
  1. v1.0.0最新Oct 15, 2026
  2. v0.2.3Oct 12, 2026
  3. v0.2.1Oct 11, 2026

评分

已满足适用检查项的 50%

该评分衡量此收录条目的完整程度,依据注册中心条目、端点与公开来源计算得出。它不是对服务器本身的评价,也不表示服务器安全或当前可用:可连通性是带日期的检查结果,评分也不包含安装量或用户评价。

  • 近 30 天内可连通25 分

    请保持端点能够响应 MCP 握手;SourceWeft 每 30 天探测一次。

  • 已声明认证方式10 分

    请在注册中心条目中声明凭据请求头,或保持端点能够响应探测,以便判定其认证方式。

  • 已列出工具15 分

    请让服务器在无凭据时响应 tools/list,或发布可在沙箱中无凭据启动的软件包。

  • 描述必需15 分
  • 图标10 分
  • 文档15 分
  • 许可证10 分