Markdown Documentation Sidecar

🚀 Markdown Sidecar MCP サーバー

このプロジェクトは、MCP サーバーを通じて、NPM パッケージ、Go モジュール、または PyPi パッケージの Markdown ドキュメントを提供およびアクセスするための構造化された方法を提供します。これらの Markdown ファイルを リソース または ツール として公開することで、コード生成をより高度なものにします。

⚠️ 重要提示

多くの PyPi パッケージは Markdown ドキュメントを公開していないため、このライブラリはデフォルトで Python の ヘルプ ルートドキュメントもマウントします。

このプロジェクトは、要求されたパッケージがインストールされているプロジェクトのメインディレクトリで実行するように設計されています。アクセスは常に現在の作業ディレクトリ内に留まります。

🚀 クイックスタート

このプロジェクトは、MCP サーバーを通じて Markdown ドキュメントを提供およびアクセスするための構造化された方法を提供します。以下に、基本的な使い方を説明します。

📦 インストール

npx -y markdown-sidecar-mcp

📚 ドキュメント

パラメータ

• workingDir: プロジェクトリポジトリの作業ディレクトリ。
• packageName: 要求されたパッケージまたはモジュールの名前。
• registry: パッケージが存在するレジストリ（npm、gomodules、または pypi）。
• docsSubDir: [オプション] Markdown ドキュメントを検索する具体的なサブディレクトリ。デフォルトはパッケージのルートディレクトリ。
• mcpPrimitive: [オプション] サーバーから公開される MCP プリミティブ (tool または resource)。デフォルトは tool で、一部のクライアントは現在 リソース をサポートしていません。

カーソルインストール手順

以下のサーバー定義を .cursor/mcp.json ファイルに追加してください。

{
  "mcpServers": {
    "sidecar": {
      "command": "npx",
      "args": [
        "-y", "--package", "markdown-sidecar-mcp",
        "--",
        "mcp", "start",
        "--workingDir", "{REPO_WORKING_DIR}",
        "--packageName", "{PACKAGE_NAME}",
        "--registry", "npm"
      ]
    }
  }
}

開発

# 依存関係のインストール
npm i

# ビルド
npm run build

# Bun で実行
npm run build:mcp

貢献ガイド

1. リポジトリをフォークする
2. 機能ブランチを作成する
3. 変更をコミットし、リモートリポジトリにプッシュする
4. プルリクエストを提出する

📄 ライセンス

このプロジェクトは MIT ライセンスの下で公開されています。詳細は LICENSE ファイルを参照してください。