TypeScript类型定义服务器

一个基于Model Context Protocol的服务器,提供NPM包的TypeScript类型定义,帮助AI助手获取和使用这些类型定义以提供更好的代码辅助。

  • by JackVCurtis
  • TypeScript
  • 本地部署
  • 1 星标
  • 更新于
在 GitHub 查看 jackvcurtis/npm-types-mcp-server

使用说明

NPM类型MCP服务器

一个MCP(模型上下文协议)服务器,用于提供TypeScript类型定义作为MCP资源。此服务器允许AI助手从NPM包中获取和使用TypeScript类型定义。

概述

此服务器实现了模型上下文协议,以提供来自NPM包的TypeScript类型定义。它允许AI助手:

  • 获取任何NPM包的类型定义
  • 访问包类型的最新或特定版本
  • 使用这些类型提供更好的代码帮助

先决条件

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

安装

  1. 克隆此存储库:

    git clone https://github.com/JackVCurtis/npm-types-mcp-server.git
    cd npm-types-mcp-server
    
  2. 安装依赖项:

    yarn
    

用法

启动服务器

要启动服务器,请运行:

yarn start

服务器将启动并通过stdio监听MCP连接。

使用Augment进行配置

要将此服务器与Augment扩展一起使用,请执行以下操作:

  1. 打开增强设置
  2. 添加具有以下配置的新MCP服务器:
    • 名字:NPM类型
    • 命令: /absolute/path/to/node /absolute/path/to/npm-types-mcp-server/index.ts
    • 替换 /absolute/path/to/node 带有Node.js可执行文件的路径
    • 替换 /absolute/path/to/npm-types-mcp-server 在您的系统上具有此存储库的绝对路径

使用服务器

配置后,您可以使用服务器获取NPM包的类型定义。服务器提供了一个名为 npm-types 可用于获取类型定义。

Augment中的示例用法:

Fetch the types for the @randsum/dice package version 1.0.0

API

工具

npm类型

获取NPM包的类型。

参数:

  • name (string):NPM包的名称
  • version (string):NPM包的版本

退货:

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

项目结构

  • index.ts:服务器的主要入口点
  • package.json:项目依赖关系和元数据
  • tsconfig.json:TypeScript配置

许可证

麻省理工学院

作者

杰克