# Dependency Upgrade Planner MCP (`reverberant_equality/mcp-dependency-upgrade-planner`) Actor Turn NPM package metadata, security advisories, and release data into actionable upgrade plans, version comparisons, security checks, and release-note summaries. - **URL**: https://apify.com/reverberant\_equality/mcp-dependency-upgrade-planner.md - **Developed by:** [Jordan C](https://apify.com/reverberant_equality) (community) - **Categories:** AI - **Stats:** 0 total users, 0 monthly users, 0.0% runs succeeded, 0 bookmarks - **User rating**: No ratings yet ## Pricing from $0.01 / 1,000 results This Actor is paid per event and usage. You are charged both the fixed price for specific events and for Apify platform usage. Learn more: https://docs.apify.com/platform/actors/running/actors-in-store#pay-per-event ## What's an Apify Actor? Actors are a software tools running on the Apify platform, for all kinds of web data extraction and automation use cases. In Batch mode, an Actor accepts a well-defined JSON input, performs an action which can take anything from a few seconds to a few hours, and optionally produces a well-defined JSON output, datasets with results, or files in key-value store. In Standby mode, an Actor provides a web server which can be used as a website, API, or an MCP server. Actors are written with capital "A". ## How to integrate an Actor? If asked about integration, you help developers integrate Actors into their projects. You adapt to their stack and deliver integrations that are safe, well-documented, and production-ready. The best way to integrate Actors is as follows. In JavaScript/TypeScript projects, use official [JavaScript/TypeScript client](https://docs.apify.com/api/client/js/docs.md): ```bash npm install apify-client ``` In Python projects, use official [Python client library](https://docs.apify.com/api/client/python/docs.md): ```bash pip install apify-client ``` In shell scripts, use [Apify CLI](https://docs.apify.com/cli/docs.md): ````bash # MacOS / Linux curl -fsSL https://apify.com/install-cli.sh | bash # Windows irm https://apify.com/install-cli.ps1 | iex ```bash In AI frameworks, you might use the [Apify MCP server](https://docs.apify.com/integrations/mcp.md). If your project is in a different language, use the [REST API](https://docs.apify.com/api/v2.md). For usage examples, see the [API](#api) section below. For more details, see Apify documentation as [Markdown index](https://docs.apify.com/llms.txt) and [Markdown full-text](https://docs.apify.com/llms-full.txt). # README ## Dependency Upgrade Planner MCP An Apify-hosted [Model Context Protocol](https://modelcontextprotocol.io/) server that turns package registry, vulnerability, and release data into **NPM upgrade decision support**. ### Scope **v1 supports NPM packages only.** Package names and versions are queried against the public NPM registry and OSV's `npm` ecosystem. Other ecosystems are intentionally out of scope for this release. The server is advisory: semver classifications, vulnerability data, release notes, and checklists **do not guarantee compatibility**. Validate upgrades in the consuming project. ### Data sources and resilience - **NPM Registry:** `https://registry.npmjs.org/{package}` for versions, publish times, metadata, and dependency groups. - **OSV:** `POST https://api.osv.dev/v1/query` for vulnerability records. - **GitHub Releases (optional):** used only when the NPM repository field safely resolves to an HTTPS GitHub `owner/repo` URL or `github:owner/repo` shorthand. Otherwise, release notes fall back to NPM publish-time data. External-source failures are non-fatal whenever another useful response can be returned. For example, an unavailable OSV response is surfaced as a source error with an empty advisory list, and an unavailable GitHub response falls back to NPM release times. No credentials or secrets are required. ### Tools #### `plan-npm-upgrade` Required inputs: `packageName`, `currentVersion`. Optional: `targetVersion` (defaults to the latest NPM dist-tag when available). Returns the latest and selected target versions, semver classification, current/target release dates and dependency counts, OSV results for both versions, risk flags, and an ordered upgrade checklist. It explicitly does not guarantee compatibility. #### `compare-npm-versions` Required inputs: `packageName`, `versions` (2–5 unique exact versions). Returns available package metadata and runtime/development/peer/optional dependency counts for each requested version, plus semver differences between consecutive versions. #### `check-npm-security` Required input: `packageName`. Optional: exact `version`. Queries OSV and returns vulnerability IDs, summaries, aliases, affected ranges, and references where supplied by OSV. #### `get-package-release-notes` Required input: `packageName`. Optional: `maxReleases` (default `10`, maximum `30`). Returns GitHub release data when a repository URL can be safely parsed and the public releases endpoint is available. Otherwise it returns an NPM registry publish-time/version fallback. Every tool call charges the Apify PPE event `tool-call` with `await Actor.charge({ eventName: 'tool-call' })`. ### Local development ```bash npm install npm run build npm test apify validate-schema APIFY_LOCAL_STORAGE_DIR=$PWD/storage APIFY_CONTAINER_PORT=3199 npm run start:dev ```` The streamable HTTP MCP endpoint is `http://localhost:3199/mcp`. Verify the tool catalog with: ```bash curl -sS -X POST http://localhost:3199/mcp \ -H 'Content-Type: application/json' \ -H 'Accept: application/json, text/event-stream' \ --data '{"jsonrpc":"2.0","id":1,"method":"tools/list","params":{}}' ``` Example upgrade request: ```bash curl -sS -X POST http://localhost:3199/mcp \ -H 'Content-Type: application/json' \ -H 'Accept: application/json, text/event-stream' \ --data '{"jsonrpc":"2.0","id":2,"method":"tools/call","params":{"name":"plan-npm-upgrade","arguments":{"packageName":"axios","currentVersion":"1.6.0"}}}' ``` ### Deployment The Actor uses standby mode and serves MCP at `/mcp`. Deploy with Apify CLI after authenticating: ```bash apify push ``` Connect an MCP client to the deployed Actor's `/mcp` endpoint with the appropriate Apify authorization header. # Actor input Schema ## Actor input object example ```json {} ``` # API You can run this Actor programmatically using our API. Below are code examples in JavaScript, Python, and CLI, as well as the OpenAPI specification and MCP server setup. ## JavaScript example ```javascript import { ApifyClient } from 'apify-client'; // Initialize the ApifyClient with your Apify API token // Replace the '' with your token const client = new ApifyClient({ token: '', }); // Prepare Actor input const input = {}; // Run the Actor and wait for it to finish const run = await client.actor("reverberant_equality/mcp-dependency-upgrade-planner").call(input); // Fetch and print Actor results from the run's dataset (if any) console.log('Results from dataset'); console.log(`💾 Check your data here: https://console.apify.com/storage/datasets/${run.defaultDatasetId}`); const { items } = await client.dataset(run.defaultDatasetId).listItems(); items.forEach((item) => { console.dir(item); }); // 📚 Want to learn more 📖? Go to → https://docs.apify.com/api/client/js/docs ``` ## Python example ```python from apify_client import ApifyClient # Initialize the ApifyClient with your Apify API token # Replace '' with your token. client = ApifyClient("") # Prepare the Actor input run_input = {} # Run the Actor and wait for it to finish run = client.actor("reverberant_equality/mcp-dependency-upgrade-planner").call(run_input=run_input) # Fetch and print Actor results from the run's dataset (if there are any) print("💾 Check your data here: https://console.apify.com/storage/datasets/" + run["defaultDatasetId"]) for item in client.dataset(run["defaultDatasetId"]).iterate_items(): print(item) # 📚 Want to learn more 📖? Go to → https://docs.apify.com/api/client/python/docs/quick-start ``` ## CLI example ```bash echo '{}' | apify call reverberant_equality/mcp-dependency-upgrade-planner --silent --output-dataset ``` ## MCP server setup ```json { "mcpServers": { "apify": { "command": "npx", "args": [ "mcp-remote", "https://mcp.apify.com/?tools=reverberant_equality/mcp-dependency-upgrade-planner", "--header", "Authorization: Bearer " ] } } } ``` ## OpenAPI specification ```json { "openapi": "3.0.1", "info": { "title": "Dependency Upgrade Planner MCP", "description": "Turn NPM package metadata, security advisories, and release data into actionable upgrade plans, version comparisons, security checks, and release-note summaries.", "version": "0.0", "x-build-id": "TmFuGtcNxyCiFjV4b" }, "servers": [ { "url": "https://api.apify.com/v2" } ], "paths": { "/acts/reverberant_equality~mcp-dependency-upgrade-planner/run-sync-get-dataset-items": { "post": { "operationId": "run-sync-get-dataset-items-reverberant_equality-mcp-dependency-upgrade-planner", "x-openai-isConsequential": false, "summary": "Executes an Actor, waits for its completion, and returns Actor's dataset items in response.", "tags": [ "Run Actor" ], "requestBody": { "required": true, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/inputSchema" } } } }, "parameters": [ { "name": "token", "in": "query", "required": true, "schema": { "type": "string" }, "description": "Enter your Apify token here" } ], "responses": { "200": { "description": "OK" } } } }, "/acts/reverberant_equality~mcp-dependency-upgrade-planner/runs": { "post": { "operationId": "runs-sync-reverberant_equality-mcp-dependency-upgrade-planner", "x-openai-isConsequential": false, "summary": "Executes an Actor and returns information about the initiated run in response.", "tags": [ "Run Actor" ], "requestBody": { "required": true, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/inputSchema" } } } }, "parameters": [ { "name": "token", "in": "query", "required": true, "schema": { "type": "string" }, "description": "Enter your Apify token here" } ], "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/runsResponseSchema" } } } } } } }, "/acts/reverberant_equality~mcp-dependency-upgrade-planner/run-sync": { "post": { "operationId": "run-sync-reverberant_equality-mcp-dependency-upgrade-planner", "x-openai-isConsequential": false, "summary": "Executes an Actor, waits for completion, and returns the OUTPUT from Key-value store in response.", "tags": [ "Run Actor" ], "requestBody": { "required": true, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/inputSchema" } } } }, "parameters": [ { "name": "token", "in": "query", "required": true, "schema": { "type": "string" }, "description": "Enter your Apify token here" } ], "responses": { "200": { "description": "OK" } } } } }, "components": { "schemas": { "inputSchema": { "type": "object", "properties": {} }, "runsResponseSchema": { "type": "object", "properties": { "data": { "type": "object", "properties": { "id": { "type": "string" }, "actId": { "type": "string" }, "userId": { "type": "string" }, "startedAt": { "type": "string", "format": "date-time", "example": "2025-01-08T00:00:00.000Z" }, "finishedAt": { "type": "string", "format": "date-time", "example": "2025-01-08T00:00:00.000Z" }, "status": { "type": "string", "example": "READY" }, "meta": { "type": "object", "properties": { "origin": { "type": "string", "example": "API" }, "userAgent": { "type": "string" } } }, "stats": { "type": "object", "properties": { "inputBodyLen": { "type": "integer", "example": 2000 }, "rebootCount": { "type": "integer", "example": 0 }, "restartCount": { "type": "integer", "example": 0 }, "resurrectCount": { "type": "integer", "example": 0 }, "computeUnits": { "type": "integer", "example": 0 } } }, "options": { "type": "object", "properties": { "build": { "type": "string", "example": "latest" }, "timeoutSecs": { "type": "integer", "example": 300 }, "memoryMbytes": { "type": "integer", "example": 1024 }, "diskMbytes": { "type": "integer", "example": 2048 } } }, "buildId": { "type": "string" }, "defaultKeyValueStoreId": { "type": "string" }, "defaultDatasetId": { "type": "string" }, "defaultRequestQueueId": { "type": "string" }, "buildNumber": { "type": "string", "example": "1.0.0" }, "containerUrl": { "type": "string" }, "usage": { "type": "object", "properties": { "ACTOR_COMPUTE_UNITS": { "type": "integer", "example": 0 }, "DATASET_READS": { "type": "integer", "example": 0 }, "DATASET_WRITES": { "type": "integer", "example": 0 }, "KEY_VALUE_STORE_READS": { "type": "integer", "example": 0 }, "KEY_VALUE_STORE_WRITES": { "type": "integer", "example": 1 }, "KEY_VALUE_STORE_LISTS": { "type": "integer", "example": 0 }, "REQUEST_QUEUE_READS": { "type": "integer", "example": 0 }, "REQUEST_QUEUE_WRITES": { "type": "integer", "example": 0 }, "DATA_TRANSFER_INTERNAL_GBYTES": { "type": "integer", "example": 0 }, "DATA_TRANSFER_EXTERNAL_GBYTES": { "type": "integer", "example": 0 }, "PROXY_RESIDENTIAL_TRANSFER_GBYTES": { "type": "integer", "example": 0 }, "PROXY_SERPS": { "type": "integer", "example": 0 } } }, "usageTotalUsd": { "type": "number", "example": 0.00005 }, "usageUsd": { "type": "object", "properties": { "ACTOR_COMPUTE_UNITS": { "type": "integer", "example": 0 }, "DATASET_READS": { "type": "integer", "example": 0 }, "DATASET_WRITES": { "type": "integer", "example": 0 }, "KEY_VALUE_STORE_READS": { "type": "integer", "example": 0 }, "KEY_VALUE_STORE_WRITES": { "type": "number", "example": 0.00005 }, "KEY_VALUE_STORE_LISTS": { "type": "integer", "example": 0 }, "REQUEST_QUEUE_READS": { "type": "integer", "example": 0 }, "REQUEST_QUEUE_WRITES": { "type": "integer", "example": 0 }, "DATA_TRANSFER_INTERNAL_GBYTES": { "type": "integer", "example": 0 }, "DATA_TRANSFER_EXTERNAL_GBYTES": { "type": "integer", "example": 0 }, "PROXY_RESIDENTIAL_TRANSFER_GBYTES": { "type": "integer", "example": 0 }, "PROXY_SERPS": { "type": "integer", "example": 0 } } } } } } } } } } ```