Development
Compare two OpenAPI 3.x schemas, identify breaking changes, grade client impact, and suggest migration or compatibility strategies
Call this tool from your code in three languages.
curl -X POST 'https://api.elysiatools.com/en/api/tools/api-breaking-changes-detector-migration-planner' \
-H 'Content-Type: application/json' \
-d '{"oldSchema":"openapi: 3.0.3\npaths:\n /users:\n post:\n requestBody:\n required: false\n content:\n application/json:\n schema:\n type: object\n properties:\n name: { type: string }\n responses:\n \"200\":\n description: ok\n content:\n application/json:\n schema:\n type: object\n properties:\n id: { type: string }\n name: { type: string }\n","newSchema":"openapi: 3.0.3\npaths:\n /users:\n post:\n requestBody:\n required: true\n content:\n application/json:\n schema:\n type: object\n required: [name, role]\n properties:\n name: { type: string }\n role: { type: string }\n responses:\n \"200\":\n description: ok\n content:\n application/json:\n schema:\n type: object\n properties:\n id: { type: string }\n"}'Send a POST request with your inputs as JSON. File parameters require a separate upload first.
POST https://api.elysiatools.com/en/api/tools/api-breaking-changes-detector-migration-planner| Name | Type | Required | Description |
|---|---|---|---|
| oldSchema | textarea | No | — |
| newSchema | textarea | No | — |
HTML result
{
"result": "<div>Processed HTML content</div>",
"error": "Error message (optional)",
"message": "Notification message (optional)",
"metadata": {
"key": "value"
}
}Add this tool to your Model Context Protocol server so AI agents can list and call it.
Add this block to your MCP client configuration:
{
"mcpServers": {
"elysiatools-api-breaking-changes-detector-migration-planner": {
"name": "api-breaking-changes-detector-migration-planner",
"description": "Compare two OpenAPI 3.x schemas, identify breaking changes, grade client impact, and suggest migration or compatibility strategies",
"baseUrl": "https://api.elysiatools.com/mcp/sse?toolId=api-breaking-changes-detector-migration-planner",
"command": "",
"args": [],
"env": {},
"isActive": true,
"type": "sse"
}
}
}After connecting to the SSE endpoint, list the exposed tools:
{
"jsonrpc": "2.0",
"id": 1,
"method": "tools/list"
}Invoke the tool by its id, passing arguments built from its parameters:
{
"jsonrpc": "2.0",
"id": 2,
"method": "tools/call",
"params": {
"name": "api-breaking-changes-detector-migration-planner",
"arguments": {
"oldSchema": "openapi: 3.0.3\npaths:\n /users:\n post:\n requestBody:\n required: false\n content:\n application/json:\n schema:\n type: object\n properties:\n name: { type: string }\n responses:\n \"200\":\n description: ok\n content:\n application/json:\n schema:\n type: object\n properties:\n id: { type: string }\n name: { type: string }\n",
"newSchema": "openapi: 3.0.3\npaths:\n /users:\n post:\n requestBody:\n required: true\n content:\n application/json:\n schema:\n type: object\n required: [name, role]\n properties:\n name: { type: string }\n role: { type: string }\n responses:\n \"200\":\n description: ok\n content:\n application/json:\n schema:\n type: object\n properties:\n id: { type: string }\n"
}
}
}Questions or issues? Contact [email protected]