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 分