Skip to main content
Glama

npmPackageReadme

Read-onlyIdempotent

Retrieves README content for NPM packages to access documentation, usage instructions, and package insights directly.

Instructions

Get the README content for NPM packages

Input Schema

TableJSON Schema
NameRequiredDescriptionDefault
packagesYesList of package names to get READMEs for
ignoreCacheNoForce a fresh lookup, ignoring the cache

Output Schema

TableJSON Schema
NameRequiredDescriptionDefault
messageNo
resultsNo
summaryNo
Behavior3/5

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

Description adds minimal behavioral context beyond annotations (readOnlyHint, idempotentHint). It does not mention caching behavior or response format, but annotations cover safety and idempotency.

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

Conciseness3/5

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

Single concise sentence, but it is too minimal. Lacks structural elements like usage context or return value hints. Would benefit from slightly more detail without losing conciseness.

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

Completeness3/5

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

For its simplicity, the description is adequate but not thorough. Missing details about caching behavior and the format of returned READMEs. Output schema may compensate, but description alone is incomplete.

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?

Schema description coverage is 100%, so baseline is 3. Description adds no extra meaning for parameters; it only names the overall action.

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

Purpose4/5

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

Description clearly states it gets README content for NPM packages using a specific verb+resource. However, it does not differentiate from sibling tools that also operate on NPM packages, missing a chance to clarify uniqueness.

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 on when to use this tool versus alternatives like npmVersions or npmLatest. The description offers no contextual hints about appropriate use cases.

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/Nekzus/npm-sentinel-mcp'

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