An MCP server that retrieves README files and usage information for npm packages from the official npm registry.
- 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
npm install -g npm-package-readme-mcp-server
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"]
}
}
}
get_package_readme({ "package_name": "react" })
get_package_info({ "package_name": "express" })
search_packages({ "query": "testing framework", "limit": 10 })
-
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)