🚀 NPM 服务器
本 NPM 服务器旨在实现特定功能，为用户提供便捷的 NPM 相关服务，可用于包的管理、分析等操作。
🚀 快速开始
本项目是一个 NPM 服务器，为用户提供了一系列 NPM 相关的功能。下面将详细介绍其安装、使用方法以及 API 文档等内容。
📦 安装指南
在项目根目录下，执行以下命令进行安装：
npm install
💻 使用示例
基础用法
使用 NPX
在使用 NPX 时，需按照以下方式进行配置：
{
"mcpServers": {
"npm-sentinel-mcp": {
"command": "npx",
"args": [
"-y",
"@nekzus/mcp-server"
]
}
}
}
使用 Claude Desktop
在 Claude Desktop 中，按如下方式配置：
{
"mcpServers": {
"npmAnalyzer": {
"transport": "stdio",
"command": "npx",
"args": ["-y", "@nekzus/mcp-server"]
}
}
}
配置文件的位置如下：
- 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
高级用法
执行以下命令进行项目构建：
npm run build
📚 详细文档
🔍 API 文档
资源
npm://registry: NPM 注册表接口npm://security: 安全分析接口npm://metrics: 包件度量接口
工具
| 工具名称 | 功能 | 输入参数 | 输出结果 |
|---|---|---|---|
npmVersions |
获取包的所有版本 | packages（字符串数组） |
版本历史和发布日期 |
npmLatest |
获取最新版本信息 | packages（字符串数组） |
最新版本详细信息和变更日志 |
npmDeps |
分析包依赖关系 | packages（字符串数组） |
完整的依赖树分析 |
npmTypes |
检查 TypeScript 支持情况 | packages（字符串数组） |
TypeScript 兼容性状态 |
npmSize |
分析包大小 | packages（字符串数组） |
打包大小和导入成本分析 |
npmVulnerabilities |
扫描安全漏洞 | packages（字符串数组） |
安全公告和严重性等级 |
npmTrends |
获取下载趋势 | packages（字符串数组）、period（"last - week" | "last - month" | "last - year"） |
时间段内下载统计数据 |
npmCompare |
比较多个包 | packages（字符串数组） |
详细比较指标 |
npmMaintainers |
获取包维护者信息 | packages（字符串数组） |
维护者详情和活动记录 |
npmScore |
获取包质量评分 | packages（字符串数组） |
全面质量度量指标 |
npmPackageReadme |
获取包 README 文件 | packages（字符串数组） |
格式化后的 README 内容 |
npmSearch |
搜索包 | query（字符串）、limit（数字，可选） |
匹配的包及其元数据 |
npmLicenseCompatibility |
检查许可证兼容性 | packages（字符串数组） |
许可证分析和兼容信息 |
npmRepoStats |
获取仓库统计信息 | packages（字符串数组） |
GitHub/仓库度量指标 |
npmDepr |
移除包 | packages（字符串数组） |
移除操作确认 |
📄 许可证
本项目采用 MIT 许可证。