Specshield Mcp Server

io.github.specshield-io由 GitHub 账号 specshield-io 发布v1.1.1更新于 Oct 24, 2026

The API-change deploy gate for AI coding agents. Read-only breaking-change detection.

已验证STDIO仅桌面开发者工具安全与监控

概览

AI 生成的概览

只读的 MCP 服务器,用于判断 OpenAPI 规范变更是否可以安全部署,并解释破坏性变更、生成迁移指南和发布说明。

可以做什么
  • 判断 API 变更是否可以安全合并或部署,给出风险与阻断原因
  • 解释破坏性变更及其对开发者和消费方的影响,并给出迁移建议
  • 生成含安全上线步骤的迁移指南,以及面向开发者、客户或内部的发布说明
  • 对比两份规范,输出破坏性变更、新增、修改与警告的原始差异及风险评分
  • 对单份规范执行 API 治理规则检查,返回定位到具体位置的问题与修复建议
适用场景
适合在助手协助处理 API 变更时使用:上线前需要明确的可行或不可行结论,或希望基于两个版本规范生成面向消费方的说明、迁移步骤和发布说明。
运行要求
通过 npx 以 stdio 在本地运行,需要 Node.js 20 或更高版本。必须在 SPECSHIELD_API_KEY 中提供 SpecShield API 密钥。可选配置包括 SPECSHIELD_API_URL(后端地址,默认 api.specshield.io)、SPECSHIELD_TIMEOUT_MS 和 SPECSHIELD_LOG_LEVEL。需要能访问后端的网络。
安装前请注意
以内联内容或路径传入的规范会被发送到所配置的 SpecShield 后端进行分析,机密 schema 需谨慎。API 密钥以 X-Api-Key 请求头发送,应作为机密保存,不要提交到代码库。治理审查工具为付费功能,免费密钥会返回 payment_required 错误。工具为只读,但传入路径时会读取该规范文件。

安装

在 SourceWeft 中

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

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

其他 MCP 客户端

参照 仓库 中的启动说明。

README

SpecShield MCP Server

The API-change deploy gate for AI coding agents. Ask "is it safe to ship this API change to my consumers?" right inside Claude, Cursor, and other MCP clients — and catch breaking changes before they reach your consumers.

It's a thin adapter over the SpecShield backend. Every tool is read-only / analyze-only — it never modifies your code.

Why not just diff specs? Plenty of tools (including free ones) list breaking changes. SpecShield's job is the decision: can I deploy this? — the deploy gate is the hero tool here.

⚙️ In CI/CD instead of an agent? The specshield CLI runs the same breaking-change and can-i-deploy checks in your pipeline (GitHub Action, exit codes). Same job, two entry points: this server for AI agents, the CLI for CI/CD.

Tools

#ToolWhat it answers
1is_change_safe ⭐Is this change safe to merge/deploy? Will it break consumers? (safeToMerge + risk + blocking reasons)
2explain_breaking_changesWhat breaks, developer & consumer impact, suggested migration
3generate_migration_guideMigration guide (markdown) + safe rollout steps
4generate_release_notesRelease notes for developer / customer / internal
5compare_specsThe raw diff (breaking / additions / modifications / warnings) + risk score
6run_governance_review 🔒API governance ruleset beyond breaking changes (missing operationId, error responses, security scheme, pagination, versioning…) → located findings + suggested fixes. Paid (Team+)

Tools 1–5 accept specs inline (baseSpecContent / targetSpecContent) or by path (baseSpecPath / targetSpecPath). run_governance_review reviews a single spec (specContent / specPath).

🔒 run_governance_review is a paid feature — a FREE API key returns a payment_required error. Upgrade at specshield.io/pricing.

Full setup, verification & troubleshooting: docs/mcp-server-setup.md.

Install

Requires Node.js ≥ 20 and a SpecShield API key (from specshield.io/account).

bash
npx -y specshield-mcp-server

Claude Desktop

claude_desktop_config.json:

json
{  "mcpServers": {    "specshield": {      "command": "npx",      "args": ["-y", "specshield-mcp-server"],      "env": { "SPECSHIELD_API_KEY": "ss_your_key_here" }    }  }}

Claude Code

bash
claude mcp add specshield --env SPECSHIELD_API_KEY=ss_your_key_here -- npx -y specshield-mcp-server

Cursor

~/.cursor/mcp.json (or the project .cursor/mcp.json):

json
{  "mcpServers": {    "specshield": {      "command": "npx",      "args": ["-y", "specshield-mcp-server"],      "env": { "SPECSHIELD_API_KEY": "ss_your_key_here" }    }  }}

Configuration

Env varRequiredDefaultPurpose
SPECSHIELD_API_KEYyes—Your SpecShield API key. Store it as a secret; never commit it.
SPECSHIELD_API_URLnohttps://api.specshield.ioBackend base URL (override for self-hosted/staging).
SPECSHIELD_TIMEOUT_MSno30000Per-request timeout.
SPECSHIELD_LOG_LEVELnoinfodebug | info | warn | error (logs go to stderr).

Example prompts (lead with the deploy gate)

  • "Here are my old and new openapi.yaml — is it safe to ship this API change to my consumers?"
  • "Compare v1.yaml and v2.yaml and tell me if I can deploy, and why not."
  • "Explain the breaking changes between these two specs and how consumers should migrate."
  • "Generate customer-facing release notes for this API change."

Security & privacy

  • API key required. Sent only as the X-Api-Key header to your configured backend.
  • Read-only / analyze-only. No mutation tools, no shell execution, no arbitrary file access (a spec file is read only when you explicitly pass a path).
  • No secret or spec logging. The server never logs spec content, API keys, or request bodies; error messages are redacted and machine-readable.
  • Specs are sent to your configured SpecShield backend for analysis.

Local development

bash
npm installnpm run build      # tsc → dist/npm test           # vitest (no network)npm run lintnpm run smoke      # boots the server against a stubbed backend and lists toolsnpm start          # run the built server over stdio

License

MIT © SpecShield Software Private Limited

来源:README.md,提交 f69c1bb

工具

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

版本历史

1
  1. v1.1.1最新Sep 16, 2026

评分

已满足适用检查项的 50%

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

  • 近 30 天内可连通25 分

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

  • 已声明认证方式10 分

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

  • 已列出工具15 分

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

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