Skip to main content
Glama

npmPackageReadme

Read-onlyIdempotent

Retrieve README content for NPM packages to access their documentation. Provide package names, and optionally bypass cache for fresh data.

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

Schema Changelog

Changes observed during successful MCP inspections.

  1. Addedv1.24.0
  2. Removedv1.23.0
  3. Changed2 schema fields changedv1.20.0
    • removedInput schema / additionalProperties
      Removed value: -false
    • addedInput schema / properties / ignoreCache
      Added value: +{
      +  "description": "Force a fresh lookup, ignoring the cache",
      +  "type": "boolean"
      +}
  4. First observedv1.0.0

TDQS

B3.2/5.0
Behavior2/5

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

Annotations already provide readOnlyHint, idempotentHint, and openWorldHint, so the bar is lowered. However, the description adds no additional behavioral context (e.g., caching behavior, multiple packages) beyond the schema.

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?

A single sentence that is concise and front-loaded. No wasted words.

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?

Despite having an output schema and annotations, the description is too minimal. It does not mention key aspects like caching or multi-package retrieval, which are important for a tool with 18 siblings and a parameter indicating cache control.

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% with both parameters documented. The description adds no extra meaning to parameters, so baseline 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 title 'Get NPM Package README' and description clearly state the action (get) and resource (NPM package README). It is specific and distinguishes from sibling tools like npmVersions and npmLatest.

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 vs alternatives. The description does not mention scenarios or when not to use it, leaving the agent without context for selection.

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