Skip to main content
Glama
kongyo2

@kongyo2/npm-info-mcp-server

Get npm Package README

npm_package_readme
Read-onlyIdempotent

Retrieve the README markdown content of any npm package, including installation instructions and usage examples.

Instructions

Get the README content of an npm package.

Returns the package's README markdown content, which typically includes installation instructions, usage examples, API documentation, and configuration options.

Args:

  • package_name (string): The npm package name

Returns: README content in markdown format. Large READMEs are truncated to 25000 characters with a notice.

Examples:

  • "zod" -> Zod README with schema validation examples

  • "express" -> Express README with routing examples

Input Schema

TableJSON Schema
NameRequiredDescriptionDefault
package_nameYesnpm package name
Behavior4/5

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

Annotations already indicate readOnlyHint=true, openWorldHint=true, idempotentHint=true, and destructiveHint=false. The description adds valuable behavioral details beyond annotations, notably that large READMEs are truncated to 25000 characters with a notice. There is no contradiction with annotations.

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

Conciseness4/5

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

The description is efficiently structured with a clear first sentence stating the purpose, followed by details on content, parameters, return value, and examples. It is concise and front-loaded, though slightly verbose with the formal 'Args:' and 'Returns:' sections.

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

Completeness5/5

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

Despite having no output schema, the description fully explains the return value format (markdown, truncation notice) and provides examples. The tool is simple with one parameter, and the description covers all necessary information for an agent to use it correctly.

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 input schema has 100% description coverage, so the baseline is 3. The description restates the parameter's purpose and provides examples like 'zod' and 'express,' which add slight contextual value but do not significantly enhance the meaning beyond the schema's 'npm package name' description.

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's purpose: 'Get the README content of an npm package.' It uses a specific verb and resource, and the tool is well-distinguished from siblings like npm_package_dependencies, npm_package_info, etc., which serve different purposes.

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?

The description does not provide any guidance on when to use this tool versus its siblings. It only explains what the tool does, leaving the agent to infer usage context. No explicit when-to-use or when-not-to-use advice is given.

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/kongyo2/npm-info'

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