npm-package-readme-mcp-server
TypeScript icon, indicating that this package has built-in type declarations

0.1.4 • Public • Published

npm-package-readme-mcp-server

npm version npm downloads GitHub stars GitHub issues license

An MCP server that retrieves README files and usage information for npm packages from the official npm registry.

Features

  • get_package_readme: Retrieve README and usage examples for npm packages
  • get_package_info: Get basic information and dependencies for npm packages
  • search_packages: Search for npm packages

Installation

npm install -g npm-package-readme-mcp-server

Setup

Add the following to your MCP client configuration file:

{
  "mcpServers": {
    "npm-package-readme": {
      "command": "npm-package-readme-mcp-server"
    }
  }
}

Alternative using npx:

{
  "mcpServers": {
    "npm-package-readme": {
      "command": "npx",
      "args": ["npm-package-readme-mcp-server"]
    }
  }
}

Usage

Get Package README

get_package_readme({ "package_name": "react" })

Get Package Information

get_package_info({ "package_name": "express" })

Search Packages

search_packages({ "query": "testing framework", "limit": 10 })

Environment Variables

  • LOG_LEVEL: Log level (ERROR, WARN, INFO, DEBUG)
  • CACHE_TTL: Cache expiration time (seconds)
  • REQUEST_TIMEOUT: Request timeout (milliseconds)
  • GITHUB_TOKEN: GitHub API token (optional, to avoid rate limits)

Package Sidebar

Install

npm i npm-package-readme-mcp-server

Weekly Downloads

38

Version

0.1.4

License

MIT

Unpacked Size

235 kB

Total Files

71

Last publish

Collaborators

  • naoto24kawa