Npm Package Docs MCP

🚀 NPM Package Docs MCP

このツールは、Model Context Protocol (MCP) を利用して、IDE内で直接最新のnpmパッケージのドキュメントを提供します。npmパッケージのGitHubリポジトリまたはパッケージに同梱されたREADMEから最新のドキュメントを取得します。

🚀 クイックスタート

このMCPツールを使用することで、古くなったり不完全な情報に依存することなく、IDE（Cursorなど）で最新のnpmパッケージのドキュメントを取得できます。以下の手順で動作します。

1. GitHubリポジトリ優先：パッケージにGitHubリポジトリがある場合、リポジトリのメインブランチ（master、main、またはdevelopブランチを試す）から直接READMEを取得します。
2. npmパッケージフォールバック：GitHubリポジトリが利用できない場合、パッケージのtarballをダウンロードし、同梱されたパッケージからREADMEファイルを抽出します。
3. リアルタイム更新：常に最新のドキュメントを取得し、最新の情報を確保します。

✨ 主な機能

• 推測の必要なし：古くなったIDEの提案に依存する代わりに、正確で最新のドキュメントを取得できます。
• 開発体験の向上：最新のドキュメントを使用して、パッケージのAPIや使用パターンを理解できます。
• エラーの削減：古いAPIリファレンスや非推奨のメソッドの使用による問題を回避できます。
• シームレスな統合：MCPプロトコルを介してIDE内で直接動作します。

📦 インストール

前提条件

• Node.js (v16以上)
• Cursor IDE (またはMCP互換のIDE)

インストール方法

Cursorに追加

Cursorに手動で追加

CursorのMCP設定ファイル（通常は~/.cursor/mcp.jsonにあります）を編集します。

{
  "mcpServers": {
    "npm-package-docs-mcp": {
      "command": "npx",
      "args": [
        "meanands/npm-package-docs-mcp"
      ]
    }
  }
}

5. Cursorを再起動：新しいMCPサーバーを読み込むためにCursor IDEを再起動します。

💻 使用例

基本的な使用法

インストール後、Cursorで以下の手順でツールを使用できます。

1. コマンドパレットを開きます（Cmd/Ctrl + Shift + P）。
2. 以下のようなリクエストを入力します。
   • "Get docs for express"
   • "Show me the latest react documentation"
   • "What's new in lodash v4?"

ツールはリクエストされたパッケージの最新のドキュメントを取得して表示します。

提供されるツール

get_docs_for_npm_package

説明：任意のnpmパッケージの最新のドキュメントを取得します。 パラメータ：

• packageName (文字列)：npmパッケージの名前（例："react"、"lodash"、"express"） 戻り値：GitHubリポジトリまたはパッケージのtarballから取得したREADMEの内容をテキストとして返します。 使用例：

// IDE内で以下のようにドキュメントを要求できます。
// "Show me the docs for express"
// "What's the latest API for react-router-dom?"
// "Get documentation for axios"

🔧 技術詳細

1. パッケージ検索：npmレジストリをクエリしてパッケージのメタデータを取得します。
2. リポジトリ検出：パッケージにGitHubリポジトリのURLがあるかどうかを確認します。
3. GitHub取得：利用可能な場合、リポジトリのメインブランチからREADME.mdを取得します。
4. Tarball抽出：GitHubリポジトリがない場合、パッケージのtarballをダウンロードして抽出し、READMEを見つけます。
5. 内容返却：ドキュメントの内容をIDEに返します。

📚 ドキュメント

開発モードでの実行

npm run dev

本番用のビルド

npm run build

プロジェクト構造

npm-docs-mcp/
├── src/
│   ├── server.ts          # メインのMCPサーバー実装
│   └── types/
│       └── index.ts       # TypeScriptの型定義
├── package.json
├── tsconfig.json
└── README.md

🤝 コントリビューション

コントリビューションを歓迎します！プルリクエストを送信してください。

📄 ライセンス

MITライセンス - 詳細はLICENSEファイルを参照してください。

🆘 サポート

問題が発生した場合や質問がある場合は、GitHubリポジトリにissueを作成してください。