Npm Sentinel MCP

🚀 NPM Server-Side Tools

This NPM server-side tool offers a comprehensive set of features for NPM package management, including installation, configuration, and various analysis functions.

🚀 Quick Start

📦 Installation

Using NPX

# Install the plugin
npm install -g @nekzus/mcp-server

# Run the server
npx @nekzus/mcp-server

Configuration File Examples

Using Claude Desktop

Add the following content to claude_desktop_config.json:

{
  "mcpServers": {
    "npmAnalyzer": {
      "transport": "stdio",
      "command": "npx",
      "args": ["-y", "@nekzus/mcp-server"]
    }
  }
}

Configuration file locations:

• Windows: %APPDATA%/claude-desktop/claude_desktop_config.json
• macOS: ~/Library/Application Support/claude-desktop/claude_desktop_config.json
• Linux: ~/.config/claude-desktop/claude_desktop_config.json

Using NPX

{
  "mcpServers": {
    "npm-sentinel-mcp": {
      "command": "npx",
      "args": [
        "-y",
        "@nekzus/mcp-server"
      ]
    }
  }
}

✨ Features

Resource Interfaces

• npm://registry: NPM registry interface
• npm://security: Security analysis interface
• npm://metrics: Package metrics interface

Toolset

npmVersions

• Get all versions of a package.
• Input: packages (array of strings)
• Output: Version history and release dates

npmLatest

• Get the latest version information.
• Input: packages (array of strings)
• Output: Detailed information about the latest version and change logs

npmDeps

• Analyze package dependencies.
• Input: packages (array of strings)
• Output: Complete dependency tree analysis

npmTypes

• Check TypeScript support.
• Input: packages (array of strings)
• Output: TypeScript compatibility status

npmSize

• Analyze package size.
• Input: packages (array of strings)
• Output: Bundle size and import cost analysis

npmVulnerabilities

• Scan for security vulnerabilities.
• Input: packages (array of strings)
• Output: Security announcements and severity ratings

npmTrends

• Get download trends.
• Input:
  • packages (array of strings)
  • period ("last-week" | "last-month" | "last-year")
• Output: Download statistics within the specified period

npmCompare

• Compare multiple packages.
• Input: packages (array of strings)
• Output: Detailed comparison metrics

npmMaintainers

• Get package maintainers.
• Input: packages (array of strings)
• Output: Maintainer information and activity status

npmScore

• Get package quality scores.
• Input: packages (array of strings)
• Output: Comprehensive quality metrics

npmPackageReadme

• Get package README files.
• Input: packages (array of strings)
• Output: Formatted README content

npmSearch

• Search for packages.
• Input:
  • query (string)
  • limit (number, optional)
• Output: Matching packages and their metadata

npmLicenseCompatibility

• Check license compatibility.
• Input: packages (array of strings)
• Output: License analysis and compatibility information

npmRepoStats

• Get repository statistics.
• Input: packages (array of strings)
• Output: GitHub/repository metrics

npm

• Get package maintainers.
• Input: packages (array of strings)
• Output: Maintainer information and activity status

🔧 Compilation and Build

Project Structure

your-project/
├── src/
│   ├── components/
│   └── pages/
├── public/
└── package.json

Build Script Example

{
  "scripts": {
    "build": "webpack --mode production",
    "dev": "webpack --mode development"
  }
}

📄 License

MIT License

Copyright (c) Year Author Name.
Distributed under the MIT License.

A copy of the MIT License is included in the accompanying file LICENSE, or you can visit the URL for more details.

Apache License 2.0

Copyright (c) Year Author Name.
Distributed under the Apache License 2.0.

A copy of the Apache License 2.0 is included in the accompanying file LICENSE, or you can visit the URL for more details.

🛠️ Development Guidelines

Code Style Guide

• Follow the project team's JavaScript code specification.
• Ensure consistent code formatting using the latest versions of ESLint and Prettier.

Documentation Writing

• Document all public APIs using the JSDoc format.
• Keep the documentation up-to-date with the code to ensure accuracy.

Version Control

• Follow the Semantic Versioning Specification (SEMVER).
• When releasing a new version, record the change log and push it to the remote repository.

🤝 Contributing to the Project

Contribution Guidelines

1. Fork the project to your account.
2. Create a new feature branch: git checkout -b feature/your-feature-name
3. Commit your changes: git add . && git commit -m 'Describe the changes you made'
4. Push to your repository: git push origin feature/your-feature-name
5. Create a Pull Request to the original project.

Code Review

• Each commit requires code review by at least one maintainer.
• Ensure that the code meets the project's quality standards and security specifications.

👥 Community Support

Asking Questions and Providing Feedback

• Ask questions in the GitHub repository: [Link to Issues page]
• Join the project's Discord community: [Discord invitation link]

Thanks to Contributors

Thank you to all volunteers and maintainers who have contributed to this project. Your efforts have made this project even better.