MCP Npm Docs Server

🚀 NPM ドキュメント MCP サーバードキュメント

このMCPサーバーは、NPMパッケージのメタデータとドキュメント（README内容を含む）を取得するためのツールを提供し、ローカルキャッシュを使用してパフォーマンスを向上させます。

✨ 主な機能

• npms.io APIを使用してパッケージのメタデータとREADME内容を取得します。
• SQLite (better-sqlite3)を使用してローカルキャッシュを行います。
• getNpmPackageDocs MCPツールを提供します。
• 標準的なMCPサーバー構造に従っています。

📚 詳細ドキュメント

プロジェクト構造

• /src: すべてのソースコードが含まれています。
  • /config: 設定管理（ConfigurationManager）。
  • /services: 核心ロジック（NpmDocService，CacheService）。
  • /tools: MCPツール定義（npmDocsTool.ts，npmDocsToolParams.ts）。
  • /types: TypeScriptインターフェースとカスタムエラー（npmDocsTypes.ts）。
  • /utils: 共有ユーティリティ関数（logger.ts，errors.ts）。
  • createServer.ts: サーバーインスタンスの作成とツールの登録。
  • server.ts: アプリケーションのエントリポイント。
• /dist: コンパイル後のJavaScript出力（npm run buildによって生成されます）。デフォルトのキャッシュDBファイル（npm-docs-cache.db）が含まれています。
• package.json: プロジェクトのメタデータと依存関係。
• tsconfig.json: TypeScriptコンパイラのオプション。
• .eslintrc.json: ESLintの設定。
• .prettierrc.json: Prettierの設定。
• .gitignore: Gitの無視ルール。

インストールと設定

1. リポジトリをクローンします（必要な場合）。

2. 依存関係をインストールします：

   npm install
   

3. サーバーをビルドします：

   npm run build
   

設定

• NPM_CACHE_TTL: キャッシュの有効期限を設定します（デフォルトは86400秒、つまり24時間）。
• NPM_CACHE_DB_PATH: キャッシュデータベースファイルのパスを設定します（デフォルトは./npm-cache.db）。
• LOG_LEVEL: ログレベルを設定します（低から高：debug, info, warn, error, fatal、デフォルトはinfo）。

サーバーの実行

• コンパイル後のサーバーを直接実行します：

  node dist/server.js
  

• 開発用にdevスクリプトを使用します：

  npm run dev
  

MCPへの統合

サーバーをMCPクライアントに設定します：

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

提供されるツール: getNpmPackageDocs

• パラメータ：

  • packageName: ドキュメントを取得するパッケージの名前。
  • forceFresh: データを強制的に再取得するかどうか（デフォルトはfalse）。

• 戻り値：

  • パッケージのメタデータとREADME内容（利用可能な場合）。

コードチェック

• Linting: npm run lint
• フォーマット: npm run format

Huskyとlint-stagedを使用して自動的にコードチェックとフォーマットが行われます。