Npm Types MCP Server

🚀 NPM Types MCP Server

An MCP (Model Context Protocol) server that provides TypeScript type definitions as MCP resources. This server allows AI assistants to retrieve and use TypeScript type definitions from NPM packages.

🚀 Quick Start

✨ Features

This server implements the Model Context Protocol to provide TypeScript type definitions from NPM packages. It enables AI assistants to:

• Retrieve type definitions for any NPM package.
• Access types for the latest or specific versions of a package.
• Utilize these types to enhance the quality of code assistance.

📦 Installation

Prerequisites

• Node.js (v23.6.0 or higher)
• yarn (v1.22.22 or higher)

Steps

1. Clone this repository:

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

2. Install dependencies:

   yarn
   

💻 Usage Examples

Starting the Server

Run the following command to start the server:

yarn start

The server will start and listen for MCP connections, communicating via standard input and output.

Configuration for Use with Augment

To use this server in this extension, follow these steps:

1. Open the Augment settings.
2. Add a new MCP server with the following configuration:
   • Name: NPM Types
   • Command: /absolute/path/to/node /absolute/path/to/npm-types-mcp-server/index.ts
   • Replace /absolute/path/to/node with the absolute path to the Node.js executable on your system.
   • Replace /absolute/path/to/npm-types-mcp-server with the absolute path to this project on your system.

Using the Server

After configuration, you can use the server to obtain type information for NPM packages. The server provides a tool called npm-types for retrieving type definitions from NPM packages.

For example, use it in Augment:

Get type information for the @randsum/dice package version 1.0.0

📚 Documentation

API

Tools

npm-types

A tool for retrieving type definitions from NPM packages.

Parameters:

• name (string): The name of the NPM package.
• version (string): The version of the NPM package.

Return Value:

• TypeScript type definitions for the specified package and version.