NPM Package Docs MCP

1# NPM Package Docs MCP
2 
3A 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.
4 
5<a href="https://glama.ai/mcp/servers/@meanands/npm-package-docs-mcp">
6  <img width="380" height="200" src="https://glama.ai/mcp/servers/@meanands/npm-package-docs-mcp/badge" alt="NPM Package Docs MCP server" />
7</a>
8 
9## What it does
10 
11This 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:
12 
131. **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)
142. **NPM Package Fallback**: If no GitHub repository is available, it downloads the package tarball and extracts the README file from the bundled package
153. **Real-time Updates**: Always gets the latest documentation, ensuring you have the most current information
16 
17## Why this matters
18 
19- **No more guesswork**: Get accurate, up-to-date documentation instead of relying on potentially outdated IDE suggestions
20- **Better development experience**: Understand package APIs and usage patterns with current documentation
21- **Reduced errors**: Avoid issues caused by using outdated API references or deprecated methods
22- **Seamless integration**: Works directly in your IDE through the MCP protocol
23 
24## Tools Provided
25 
26### `get_docs_for_npm_package`
27 
28**Description**: Retrieves the latest documentation for any npm package
29 
30**Parameters**:
31- `packageName` (string): The name of the npm package (e.g., "react", "lodash", "express")
32 
33**Returns**: The README content as text, either from the GitHub repository or the package tarball
34 
35**Example Usage**:
36```typescript
37// In your IDE, you can now ask for documentation like:
38// "Show me the docs for express"
39// "What's the latest API for react-router-dom?"
40// "Get documentation for axios"
41```
42 
43## How it Works
44 
451. **Package Lookup**: Queries the npm registry to get package metadata
462. **Repository Detection**: Checks if the package has a GitHub repository URL
473. **GitHub Fetch**: If available, fetches README.md from the repository's main branch
484. **Tarball Extraction**: If no GitHub repo, downloads and extracts the package tarball to find the README
495. **Content Return**: Returns the documentation content to your IDE
50 
51## Installation
52 
53### Prerequisites
54 
55- Node.js (v16 or higher)
56- Cursor IDE (or any MCP-compatible IDE)
57 
58### Installation
59 
60#### Add to Cursor
61 
62[![Install MCP Server](https://cursor.com/deeplink/mcp-install-dark.svg)](https://cursor.com/en/install-mcp?name=npm-package-docs-mcp&config=eyJjb21tYW5kIjoibnB4IG1lYW5hbmRzL25wbS1wYWNrYWdlLWRvY3MtbWNwIn0%3D)
63 
64#### Add manually to Cursor
65 
66   Edit your Cursor MCP configuration file (usually located at `~/.cursor/mcp.json`):
67 
68   ```json
69   {
70     "mcpServers": {
71       "npm-package-docs-mcp": {
72         "command": "npx",
73         "args": [
74           "meanands/npm-package-docs-mcp"
75         ]
76       }
77     }
78   }
79   ```
80 
815. **Restart Cursor**: Restart Cursor IDE to load the new MCP server
82 
83## Usage
84 
85Once installed, you can use the tool in Cursor by:
86 
871. Opening the command palette (Cmd/Ctrl + Shift + P)
882. Typing your request, for example:
89   - "Get docs for express"
90   - "Show me the latest react documentation"
91   - "What's new in lodash v4?"
92 
93The tool will fetch and display the current documentation for the requested package.
94 
95## Development
96 
97### Running in Development Mode
98 
99```bash
100npm run dev
101```
102 
103### Building for Production
104 
105```bash
106npm run build
107```
108 
109### Project Structure
110 
111```
112npm-docs-mcp/
113├── src/
114│   ├── server.ts          # Main MCP server implementation
115│   └── types/
116│       └── index.ts       # TypeScript type definitions
117├── package.json
118├── tsconfig.json
119└── README.md
120```
121 
122## Contributing
123 
124Contributions are welcome! Please feel free to submit a Pull Request.
125 
126## License
127 
128MIT License - see the LICENSE file for details.
129 
130## Support
131 
132If you encounter any issues or have questions, please open an issue on the GitHub repository.