meanands/npm-package-docs-mcp

Developer tools

Эта страница переведена автоматически. Технические детали смотрите в оригинале. Открыть оригинал

11 stars 7 forks Качество 56 Тренд 18MIT

Repository Install

A Model Context Protocol (MCP) tool that provides up-to-date documentation for npm packages directly in your IDE.

Обзор

A Model Context Protocol (MCP) tool that provides up-to-date documentation for npm packages directly in your IDE. This tool fetches the latest README documentation from either the package's GitHub repository or the README bundled with the npm package itself. This MCP tool helps your IDE (like Cursor) get the most current documentation for any npm package instead of relying on outdated or incomplete information. It works by: 1. : If the package has a GitHub repository, it fetches the README directly from the repository's main branch (trying master, main, or develop branches) 2. : If no GitHub repository is available, it downloads the package tarball and extracts the README file from the bundled package 3.

README

Показан фрагмент оригинального README. Открыть оригинал.

NPM Package Docs MCP

What it does

This MCP tool helps your IDE (like Cursor) get the most current documentation for any npm package instead of relying on outdated or incomplete information. It works by:

GitHub Repository First: If the package has a GitHub repository, it fetches the README directly from the repository’s main branch (trying master, main, or develop branches)
NPM Package Fallback: If no GitHub repository is available, it downloads the package tarball and extracts the README file from the bundled package
Real-time Updates: Always gets the latest documentation, ensuring you have the most current information

Why this matters

No more guesswork: Get accurate, up-to-date documentation instead of relying on potentially outdated IDE suggestions
Better development experience: Understand package APIs and usage patterns with current documentation
Reduced errors: Avoid issues caused by using outdated API references or deprecated methods
Seamless integration: Works directly in your IDE through the MCP protocol

Tools Provided

`get_docs_for_npm_package`

Description: Retrieves the latest documentation for any npm package

Parameters:

packageName (string): The name of the npm package (e.g., “react”, “lodash”, “express”)

Returns: The README content as text, either from the GitHub repository or the package tarball

Example Usage:

// In your IDE, you can now ask for documentation like:
// "Show me the docs for express"
// "What's the latest API for react-router-dom?"
// "Get documentation for axios"

How it Works

Package Lookup: Queries the npm registry to get package metadata
Repository Detection: Checks if the package has a GitHub repository URL
GitHub Fetch: If available, fetches README.md from the repository’s main branch
Tarball Extraction: If no GitHub repo, downloads and extracts the package tarball to find the README
Content Return: Returns the documentation content to your IDE

Installation

Prerequisites

Node.js (v16 or higher)
Cursor IDE (or any MCP-compatible IDE)

Installation

Add to Cursor

Add manually to Cursor

Открыть полный README на GitHub

Установка

npx meanands/npm-package-docs-mcp

Новичок в MCP? Начните с руководства на mcpskill.org →

Конфигурация

{
     "mcpServers": {
       "npm-package-docs-mcp": {
         "command": "npx",
         "args": [
           "meanands/npm-package-docs-mcp"
         ]
       }
     }
   }