Skip to main content
Glama

check_compatibility

Check if a package version is compatible with your project's existing dependencies. Specify the package and its version range to detect potential conflicts before installing.

Instructions

Analyze compatibility of a package with existing project dependencies

Input Schema

TableJSON Schema
NameRequiredDescriptionDefault
versionNoVersion or version range
packageNameYesName of the package to check
existingDependenciesYesExisting package.json dependencies
Behavior2/5

Does the description disclose side effects, auth requirements, rate limits, or destructive behavior?

With no annotations, the description carries the full burden of behavioral disclosure. It merely says 'Analyze compatibility,' which implies a read-only action, but it does not disclose whether this performs network calls, how results are returned (e.g., boolean, report, errors), or any side effects. This leaves critical behavioral traits unexplained.

Agents need to know what a tool does to the world before calling it. Descriptions should go beyond structured annotations to explain consequences.

Conciseness5/5

Is the description appropriately sized, front-loaded, and free of redundancy?

The description is a single, front-loaded sentence that directly states the tool's purpose without any fluff. Every word serves to communicate the core function, making it highly concise and appropriately structured.

Shorter descriptions cost fewer tokens and are easier for agents to parse. Every sentence should earn its place.

Completeness2/5

Given the tool's complexity, does the description cover enough for an agent to succeed on first attempt?

The tool has three parameters including a nested object, and no output schema. The description does not explain what the compatibility result looks like, what 'compatibility' means in this context, or how the version parameter affects the analysis. A more complete description should outline the output format and any assumptions about dependencies.

Complex tools with many parameters or behaviors need more documentation. Simple tools need less. This dimension scales expectations accordingly.

Parameters3/5

Does the description clarify parameter syntax, constraints, interactions, or defaults beyond what the schema provides?

The schema provides 100% coverage for all three parameters, including descriptions for packageName, existingDependencies, and version. The description adds no additional semantic meaning beyond what the schema already documents, so the baseline score of 3 is appropriate.

Input schemas describe structure but not intent. Descriptions should explain non-obvious parameter relationships and valid value ranges.

Purpose5/5

Does the description clearly state what the tool does and how it differs from similar tools?

The description clearly states the tool analyzes compatibility of a package with existing project dependencies. The verb 'Analyze' combined with the specific resource 'compatibility of a package with existing project dependencies' distinguishes it from sibling tools like compare_versions or analyze_quality.

Agents choose between tools based on descriptions. A clear purpose with a specific verb and resource helps agents select the right tool.

Usage Guidelines2/5

Does the description explain when to use this tool, when not to, or what alternatives exist?

No guidance is provided about when to use this tool instead of alternatives. It does not mention exclusions, prerequisites, or context such as comparing two packages or checking security, leaving the agent without explicit usage direction.

Agents often have multiple tools that could apply. Explicit usage guidance like "use X instead of Y when Z" prevents misuse.

Install Server

Other Tools

Latest Blog Posts

MCP directory API

We provide all the information about MCP servers via our MCP API.

curl -X GET 'https://glama.ai/api/mcp/v1/servers/alisaitteke/npm-mcp'

If you have feedback or need assistance with the MCP directory API, please join our Discord server