@bradford-tech/npm-package-readme-mcp-server
This server provides an MCP interface to the npm registry, offering the following tools:
get_readme_from_npm: Fetches a package's README (with GitHub fallback) and optionally extracts usage examples. Supports specific versions and dist-tags.get_package_info_from_npm: Returns detailed metadata, version info, download statistics, and optionally runtime and/or dev dependencies for a package.search_packages_from_npm: Searches the npm registry by keyword/query, with control over result count (1–250) and optional filtering by minimum quality and popularity scores.
Additionally, you can configure a GitHub personal access token to improve API rate limits when fetching READMEs from GitHub, and customize caching TTL and per-request timeouts.
Fetches npm package READMEs, metadata, and search results from the npm registry. Provides tools for retrieving package readmes, package info, and searching for packages.
Click on "Deploy Server".
Wait a few minutes for the server to deploy. Once ready, it will show a "Started" state.
In the chat, type
@followed by the MCP server name and your instructions, e.g., "@@bradford-tech/npm-package-readme-mcp-server show me the readme for lodash"
That's it! The server will respond to your query, and you can continue using it as needed.
Here is a step-by-step guide with screenshots.
@bradford-tech/npm-package-readme-mcp-server
An MCP server that exposes npm registry data — package READMEs, metadata, and search — to MCP-compatible AI clients.
This is a maintained fork of
naoto24kawa/npm-package-readme-mcp-server, republished under the@bradford-techscope after the original was removed from GitHub and npm. No functional changes from the upstream0.1.4release.
Install
npm install -g @bradford-tech/npm-package-readme-mcp-serverAlso works with pnpm add -g, yarn global add, or via npx (no install needed).
Related MCP server: npm-docs-server
Configure your MCP client
Add the server to your client's MCP configuration:
{
"mcpServers": {
"npm-package-readme": {
"command": "npm-package-readme-mcp-server"
}
}
}Or run on demand with npx:
{
"mcpServers": {
"npm-package-readme": {
"command": "npx",
"args": ["-y", "@bradford-tech/npm-package-readme-mcp-server"]
}
}
}Tools
The server exposes three tools to the connected client.
get_readme_from_npm
Fetches a package's README and extracts usage examples. Reads from the npm registry first, falls back to the linked GitHub repository.
Parameter | Type | Default | Description |
| string | — | The npm package name (required). |
| string |
| Specific version or dist-tag. |
| boolean |
| Parse and return usage examples extracted from the README. |
Example call:
{ "package_name": "react", "version": "18.2.0" }get_package_info_from_npm
Returns package metadata and download statistics for the latest version.
Parameter | Type | Default | Description |
| string | — | The npm package name (required). |
| boolean |
| Include runtime dependencies. |
| boolean |
| Include dev dependencies. |
Example call:
{ "package_name": "express", "include_dependencies": true }search_packages_from_npm
Searches the npm registry.
Parameter | Type | Default | Description |
| string | — | Search text (required). |
| number |
| Max results, 1–250. |
| number | — | Minimum quality score, 0–1. |
| number | — | Minimum popularity score, 0–1. |
Example call:
{ "query": "testing framework", "limit": 10 }How package data is fetched
Package metadata and READMEs come from
registry.npmjs.org.If the registry response has no README, the server resolves the
repositoryfield and fetches the README from the GitHub API.Download statistics come from
api.npmjs.org/downloads.Responses are cached in memory (default TTL: 1 hour; search results: 10 minutes).
GitHub anonymous API requests are rate-limited to 60/hour. The server logs a warning when no token is available but still works for low-volume use.
Configuration
All settings are optional environment variables, passed via your MCP client's env field (or your shell, when launching directly).
Variable | Default | Description |
|
| Default cache TTL in seconds for |
|
| Per-request timeout in milliseconds, applied to npm registry and GitHub API calls. |
| — | GitHub personal access token. Raises the GitHub API rate limit from 60/hour to 5000/hour. |
|
| One of |
Example, with a GitHub token:
{
"mcpServers": {
"npm-package-readme": {
"command": "npm-package-readme-mcp-server",
"env": {
"GITHUB_TOKEN": "ghp_..."
}
}
}
}Requirements
Node.js >= 20
Contributing
Issues and pull requests welcome at bradford-tech/npm-package-readme-mcp-server. See CONTRIBUTING.md for the developer setup.
License
MIT. See LICENSE.
Available Tools
3 toolsget_package_info_from_npmB
Get package basic information and dependencies from npm registry
Inputs: package_name (required), include_dependencies, include_dev_dependencies.
get_readme_from_npmB
Get package README and usage examples from npm registry
Inputs: package_name (required), version, include_examples.
search_packages_from_npmB
Search for packages in npm registry
Inputs: query (required), limit, quality, popularity.
Tool Schema Changelog
Recent tool additions, removals, and schema changes observed during successful MCP inspections.
Loading tool schema changelog…
TDQS
Scored across 3 tools
Each tool targets a clearly distinct operation: searching for packages, retrieving package metadata, and fetching README content. There is no ambiguity between searching and retrieving specific package resources.
All three tool names follow a consistent verb_noun_from_npm pattern (get_readme, get_package_info, search_packages). The verb choice appropriately reflects each action, and the structure is uniform throughout.
Three tools is on the lean side, but the server has a narrow, focused purpose (npm package readme retrieval), so each tool earns its place. The count feels slightly thin rather than excessive or insufficient.
The core workflow is covered: search for a package, inspect its metadata, then fetch its README. Minor gaps exist, such as fetching version-specific readmes or resolving readmes from alternate sources, but there are no dead ends for the stated purpose.
Maintenance
Related MCP Connectors
npm MCP — wraps the npm Registry API (free, no auth)
Dive into the world of npm with our NPM Package Info MCP. Access crucial metadata about any npm
Live npm and UNPKG data for AI agents: resolution, audits, import maps, malware/CVE checks.
Search and fetch AI agent skills, rules files and MCP servers indexed from GitHub.
Related MCP Servers
- AlicenseCqualityDmaintenanceMCP server for searching npm packages1252 npm16MIT
- AlicenseNot gradedqualityDmaintenanceFetches metadata and README documentation for NPM packages, with local caching via SQLite for improved performance.3MIT
- AlicenseAqualityFmaintenanceMCP server that provides npm package information for AI agents during TypeScript development.79 npm1MIT
- AlicenseAqualityDmaintenanceMCP server providing npm registry search, package details, dependency auditing, bundle size estimation, and package comparison tools for AI agents.539 npmMIT