MCP Npm Docs Server

🚀 NPM Documentation MCP Server Documentation

An MCP server that provides tools to retrieve NPM package metadata and documentation (including README content), and uses local caching to improve performance.

✨ Features

• Utilize the npms.io API to fetch package metadata and README content.
• Employ SQLite (better-sqlite3) for local caching.
• Offer the getNpmPackageDocs MCP tool.
• Adhere to the standard MCP server structure.

📁 Project Structure

• /src: Contains all source code.
  • /config: Configuration management (ConfigurationManager).
  • /services: Core logic (NpmDocService, CacheService).
  • /tools: MCP tool definitions (npmDocsTool.ts, npmDocsToolParams.ts).
  • /types: TypeScript interfaces and custom errors (npmDocsTypes.ts).
  • /utils: Shared utility functions (logger.ts, errors.ts).
  • createServer.ts: Server instance creation and tool registration.
  • server.ts: Application entry point.
• /dist: Compiled JavaScript output (generated by npm run build). Includes the default cache DB file (npm-docs-cache.db).
• package.json: Project metadata and dependencies.
• tsconfig.json: TypeScript compiler options.
• .eslintrc.json: ESLint configuration.
• .prettierrc.json: Prettier configuration.
• .gitignore: Git ignore rules.

📦 Installation and Setup

1. Clone the repository (if applicable).

2. Install dependencies:

   npm install
   

3. Build the server:

   npm run build
   

⚙️ Configuration

• NPM_CACHE_TTL: Set the cache expiration time (default is 86400 seconds, i.e., 24 hours).
• NPM_CACHE_DB_PATH: Set the cache database file path (default is ./npm-cache.db).
• LOG_LEVEL: Set the log level (from low to high: debug, info, warn, error, fatal; default is info).

🚀 Running the Server

• Run the compiled server directly:

  node dist/server.js
  

• Use the dev script for development:

  npm run dev
  

🔌 MCP Integration

Configure the server in the MCP client:

{
  "server_name": "npm-docs-server",
  "tool_name": "getNpmPackageDocs",
  "arguments": {
    "packageName": "lodash",
    "forceFresh": false
  }
}

💻 Provided Tool: getNpmPackageDocs

• Parameters:

  • packageName: The name of the package for which documentation needs to be retrieved.
  • forceFresh: Whether to force re-fetching the data (default is false).

• Return Value:

  • Package metadata and README content (if available).

🛠️ Code Checks

• Linting: npm run lint
• Formatting: npm run format

Automated code checks and formatting are performed through Husky and lint-staged.