Npm Types MCP Server

🚀 NPM 类型 MCP 服务器

NPM 类型 MCP 服务器是一个提供 TypeScript 类型定义作为 MCP 资源的 MCP (Model Context Protocol) 服务器。它允许 AI 助手从 NPM 包中获取并使用 TypeScript 类型定义，有效提升代码辅助的质量。

🚀 快速开始

NPM 类型 MCP 服务器实现了 Model Context Protocol，可提供 NPM 包中的 TypeScript 类型定义，让 AI 助手能够获取任意 NPM 包的类型定义，访问包最新版本或特定版本的类型，进而提高代码辅助的质量。

✨ 主要特性

• 可获取任何 NPM 包的类型定义。
• 支持访问包的最新版本或特定版本的类型。
• 有助于 AI 助手利用这些类型提高代码辅助质量。

📦 安装指南

环境要求

• Node.js (v23.6.0 或更高版本)
• yarn (v1.22.22 或更高版本)

安装步骤

1. 克隆此仓库：

   git clone https://github.com/JackVCurtis/npm-types-mcp-server.git
   cd npm-types-mcp-server
   

2. 安装依赖项：

   yarn
   

💻 使用示例

基础用法

启动服务器

运行以下命令启动服务器：

yarn start

服务器将启动并监听 MCP 连接，通过标准输入输出进行通信。

与 Augment 配合使用配置

要在此扩展中使用此服务器，请按照以下步骤操作：

1. 打开 Augment 设置。
2. 添加一个新的 MCP 服务器，配置如下：
   • 名称：NPM 类型
   • 命令：/绝对路径/to/node /绝对路径/to/npm-types-mcp-server/index.ts
   • 将 /绝对路径/to/node 替换为您系统的 Node.js 可执行文件的绝对路径。
   • 将 /绝对路径/to/npm-types-mcp-server 替换为该项目在您系统上的绝对路径。

使用服务器

配置完成后，您可以使用服务器来获取 NPM 包的类型信息。服务器提供了一个名为 npm-types 的工具，用于从 NPM 包中获取类型定义。

例如，在 Augment 中使用：

获取 @randsum/dice 包版本 1.0.0 的类型信息

📚 详细文档

API

工具

npm-types

从 NPM 包中获取类型定义的工具。

参数：

• name (字符串)：NPM 包的名称
• version (字符串)：NPM 包的版本

返回值：

• 指定包和版本的 TypeScript 类型定义