Javadoc Mcp

Name: Javadoc Mcp
Author: BeamLiu

ローカル

github.com/BeamLiu開発ツール151 週間前に更新

リポジトリ

Javadoc Mcp について

Javadoc Mcpは、Javaソースや対応するHTML Javadocを構造化JSONに変換し、文書を検索するツール群です。クラス、メソッド、コンストラクター、フィールドをMCP経由で調べたいJava開発者向けです。

主な機能

01JavaソースからJSONを生成
02対応するHTML Javadocのクロール
03delombokによるLombok処理
04正規表現によるパッケージ絞り込み
05Javaドキュメントのファジー検索
06ドキュメント統計の表示

活用シーン

01Javaソースから検索可能なJSONを作成
02生成ドキュメント内のクラスやメソッドを検索
03コーディング中にクラス詳細を参照

MCP 対応

Node.js製MCPサーバーが生成済みのJavaドキュメントを検索し、クラス、メソッド、コンストラクター、フィールド、統計情報の照会をMCPクライアントに提供します。

#javadoc #java-docs #documentation-generator

設定

ローカルサーバーの設定はどのクライアントでも共通です。コピーしてクライアントの MCP 設定ファイルに貼り付けてください。

mcp.json · 共通設定

{
  "mcpServers": {
    "java-doc": {
      "command": "npx",
      "args": [
        "-y",
        "@io.emop/mcp-javadoc-server"
      ]
    }
  }
}

起動コマンドnpx -y @io.emop/mcp-javadoc-server

ローカルサーバーにはマシン上の実行環境（Node.js 18 以上など）が必要です。設定ファイルの場所はクライアントごとに異なります。

パッケージ

npm@io.emop/mcp-javadoc-serverstdio

ツール

掲載時のツール一覧 · 2 週間前に更新

パラメーター	型	必須	説明
limit	number	いいえ	返す結果の最大数（デフォルト：10）
mode	enum	いいえ	検索モード：fuzzy（デフォルト）、keyword（部分一致）、regex（正規表現）fuzzy \| keyword \| regex
query	string	はい	検索クエリ（例：“TestClass”、“getName”、“nxopen.features”）

詳細

MCP Java Documentation / MCP Java 文档

English | 中文

English

Java ソースコードから構造化された JSON ドキュメントを生成し、MCP（Model Context Protocol）を通じて高度な検索機能を提供する包括的なソリューションです。

🚀 概要

このプロジェクトは、連携して完全な Java ドキュメントエコシステムを構築する、次の 3 つの主要コンポーネントで構成されています。

Maven Plugin (java-docs-json-doclet) - Java ソースコードから構造化された JSON ドキュメントを生成します
MCP Server (mcp-server) - 生成されたドキュメントに対する高度な検索およびクエリ機能を提供します
Sample Data (javadoc-json) - テストと参照用の JSON ドキュメントファイルのサンプルです

🏗️ アーキテクチャ

┌─────────────────────┐    ┌─────────────────────┐    ┌─────────────────────┐
│   Java Source Code  │    │   HTML Javadoc      │    │   Lombok Projects   │
│                     │    │   (JDK 9)          │    │                     │
└──────────┬──────────┘    └──────────┬──────────┘    └──────────┬──────────┘
           │                          │                          │
           ▼                          ▼                          ▼
┌─────────────────────────────────────────────────────────────────────────────┐
│                    Maven Plugin (java-docs-json-doclet)                     │
│  ┌─────────────────┐  ┌─────────────────┐  ┌─────────────────────────────┐  │
│  │  Publish Goal   │  │   Crawl Goal    │  │      Lombok Support         │  │
│  │  (Source Code)  │  │  (HTML Docs)    │  │     (Delombok Process)      │  │
│  └─────────────────┘  └─────────────────┘  └─────────────────────────────┘  │
└─────────────────────────────┬───────────────────────────────────────────────┘
                              │
                              ▼
                    ┌─────────────────────┐
                    │   JSON Documentation│
                    │   (Structured Data) │
                    └──────────┬──────────┘
                              │
                              ▼
┌─────────────────────────────────────────────────────────────────────────────┐
│                           MCP Server                                        │
│  ┌─────────────────┐  ┌─────────────────┐  ┌─────────────────────────────┐  │
│  │  Search Classes │  │  Search Methods │  │      Get Statistics         │  │
│  │                 │  │                 │  │                             │  │
│  └─────────────────┘  └─────────────────┘  └─────────────────────────────┘  │
└─────────────────────────────┬───────────────────────────────────────────────┘
                              │
                              ▼
                    ┌─────────────────────┐
                    │   Claude Desktop    │
                    │   (AI Assistant)    │
                    └─────────────────────┘

📦 コンポーネント

1. Java Docs JSON Doclet (`java-docs-json-doclet/`)

Java ドキュメントを構造化された JSON 形式に変換する Maven プラグインです。

サポート対象の Java バージョン：

ゴール	サポート対象バージョン	備考
javadoc-json	Java 8+	Java 8 以降のすべてのバージョンをサポートします
Crawl	Java 9	将来的に他のバージョンもサポートする予定です。現在は https://docs.sw.siemens.com/documentation/external/PL20231101866122454/en-US/custom_api/open_java_ref/ のみをサポートしています。独自の HTML から JSON へのパーサーを構築するには、`io.emop.javadocjson.doclet.JsonDoclet` を更新してください

今後のリリースで、将来の Java バージョンもサポートする予定です

機能：

Javadoc Json Goal の生成：Java ソースコードから JSON を生成します
Crawl Goal：HTML Javadoc サイトからドキュメントを抽出します（JDK 9 以降をサポート）
Lombok サポート：delombok 処理を使用して Lombok アノテーションを処理します
MCP 対応：MCP 互換形式でドキュメントを生成します
パッケージのフィルタリング：正規表現パターンを使って特定のパッケージをフィルタリングします
プロキシのサポート：外部ドキュメントをクロールするためのプロキシ設定を構成します

クイックスタート：

<plugin>
    <groupId>io.github.beamliu</groupId>
    <artifactId>java-docs-json-doclet</artifactId>
    <version>0.1.1</version>
</plugin>

Lombok を使用している場合、コンパイルエラーが発生することがあります。Lombok Projects セクションを参照してください。

詳細については、README を参照してください。

2. MCP Server (`mcp-server/`)

Java ドキュメントの高度な検索機能を提供する、Node.js ベースの MCP サーバーです。

機能：

あいまい検索：Fuse.js による高度なマッチングを提供します
複数の検索タイプ：クラス、メソッド、コンストラクター、フィールドを検索します
データの重複排除：重複したエントリーを自動的に統合します
統計情報：ドキュメントの網羅状況を確認できます
Claude との連携：Claude Desktop とシームレスに連携します

クイックスタート：

npx @io.emop/mcp-javadoc-server --javadoc-path /path/to/javadoc-json

3. Sample Data (`javadoc-json/`)

テストおよび参照用に、さまざまな Java プロジェクトから生成した JSON ドキュメントファイルのサンプルが含まれています。

🚀 はじめに

ステップ 1：JSON ドキュメントを生成する

ソースコードから：

Maven 依存関係を追加します。

<plugin>
    <groupId>io.github.beamliu</groupId>
    <artifactId>java-docs-json-doclet</artifactId>
    <version>0.1.1</version>
</plugin>

次に、以下を実行します。

mvn javadoc-json:javadoc-json

Maven 設定のサンプルは ./java-docs-json-doclet/examples/ にあります。

HTML Javadoc から：

README を参照してください。

ステップ 2：MCP サーバーを起動する

# Using npx (recommended, no installation needed)
npx @io.emop/mcp-javadoc-server --javadoc-path /path/to/javadoc-json

mcp inspector を使用してテストします。

npx @modelcontextprotocol/inspector npx -y @io.emop/mcp-javadoc-server -- --javadoc-path /path/to/javadoc-json

README を参照してください。

📖 使用例

設定が完了すると、Claude Desktop で次のコマンドを使用できます。

すべての項目を検索：search_all("ArrayList")
クラスを検索：search_classes("HashMap")
メソッドを検索：search_methods("toString")
クラスの詳細を取得：get_class_details("java.util.List")
統計情報を取得：get_stats()

🔧 高度な設定

Lombok プロジェクト

Lombok を使用するプロジェクトでは、delombok 処理を構成してください。

README を参照してください。

📄 ライセンス

このプロジェクトは MIT License のもとでライセンスされています。

中国語

Java ソースコードから構造化 JSON ドキュメントを生成し、MCP（モデルコンテキストプロトコル）を通じてスマート検索機能を提供する、完全なソリューションです。

🚀 概要

本プロジェクトは、連携して完全な Java ドキュメントエコシステムを構築する、3 つの主要コンポーネントで構成されています。

Maven プラグイン (java-docs-json-doclet) - Java ソースコードから構造化 JSON ドキュメントを生成します
MCP サーバー (mcp-server) - 生成されたドキュメントに対して、スマート検索とクエリ機能を提供します
サンプルデータ (javadoc-json) - テストと参考用のサンプル JSON ドキュメントファイルです

🏗️ アーキテクチャ

┌─────────────────────┐    ┌─────────────────────┐    ┌─────────────────────┐
│     Java 源代码      │    │   HTML Javadoc      │    │   Lombok 项目       │
│                     │    │   (JDK 9)          │    │                     │
└──────────┬──────────┘    └──────────┬──────────┘    └──────────┬──────────┘
           │                          │                          │
           ▼                          ▼                          ▼
┌─────────────────────────────────────────────────────────────────────────────┐
│                    Maven 插件 (java-docs-json-doclet)                       │
│  ┌─────────────────┐  ┌─────────────────┐  ┌─────────────────────────────┐  │
│  │   发布目标      │  │   爬取目标      │  │      Lombok 支持            │  │
│  │  (源代码)       │  │  (HTML 文档)    │  │     (Delombok 过程)         │  │
│  └─────────────────┘  └─────────────────┘  └─────────────────────────────┘  │
└─────────────────────────────┬───────────────────────────────────────────────┘
                              │
                              ▼
                    ┌─────────────────────┐
                    │   JSON 文档         │
                    │   (结构化数据)      │
                    └──────────┬──────────┘
                              │
                              ▼
┌─────────────────────────────────────────────────────────────────────────────┐
│                           MCP 服务器                                        │
│  ┌─────────────────┐  ┌─────────────────┐  ┌─────────────────────────────┐  │
│  │   搜索类        │  │   搜索方法      │  │      获取统计信息           │  │
│  │                 │  │                 │  │                             │  │
│  └─────────────────┘  └─────────────────┘  └─────────────────────────────┘  │
└─────────────────────────────┬───────────────────────────────────────────────┘
                              │
                              ▼
                    ┌─────────────────────┐
                    │   Claude Desktop    │
                    │   (AI 助手)         │
                    └─────────────────────┘

📦 コンポーネント

1. Java Docs JSON Doclet (`java-docs-json-doclet/`)

Java ドキュメントを構造化 JSON 形式に変換する Maven プラグインです。

対応する Java バージョン：

対象	対応バージョン	説明
javadoc-json	Java 8+	Java 8 以降のすべてのバージョンに対応しています
クロール (Crawl)	Java 9	今後、他のバージョンにも対応予定です。現在は https://docs.sw.siemens.com/documentation/external/PL20231101866122454/en-US/custom_api/open_java_ref/ のみ対応しています。`io.emop.javadocjson.doclet.JsonDoclet` を更新すれば、独自の HTML から JSON へのパーサーを構築できます

今後の Java バージョンは、今後のリリースで対応予定です

機能：

Javadoc Json ターゲットの生成：Java ソースコードから JSON を生成します
クロールターゲット：HTML Javadoc サイトからドキュメントを抽出します（JDK 9+ に対応）
Lombok 対応：delombok 処理を通じて Lombok アノテーションを処理します
MCP 互換：MCP 互換形式のドキュメントを生成します
パッケージフィルタリング：正規表現パターンを使用して特定のパッケージをフィルタリングします
プロキシ対応：外部ドキュメントをクロールするためのプロキシ設定を構成します

クイックスタート：

<plugin>
    <groupId>io.github.beamliu</groupId>
    <artifactId>java-docs-json-doclet</artifactId>
    <version>0.1.1</version>
</plugin>

Lombok を使用している場合、コンパイルエラーが発生することがあります。その場合は、Lombok プロジェクトのセクションに進んでください。

詳細については、READMEを参照してください。

2. MCP サーバー (`mcp-server/`)

Java ドキュメントのスマート検索機能を提供する、Node.js ベースの MCP サーバーです。

機能：

あいまい検索：Fuse.js によるスマートな照合
複数の検索タイプ：クラス、メソッド、コンストラクター、フィールド
データの重複排除：重複する項目を自動的に統合します
統計情報：ドキュメントの網羅率の概要を取得します
Claude との統合：Claude Desktop とシームレスに統合します

クイックスタート：

npx @io.emop/mcp-javadoc-server --javadoc-path /path/to/javadoc-json

3. サンプルデータ (`javadoc-json/`)

さまざまな Java プロジェクトから生成されたサンプル JSON ドキュメントファイルが含まれており、テストと参考に使用できます。

🚀 はじめに

ステップ 1：JSON ドキュメントを生成する

ソースコードから：

Maven の依存関係を追加します

<plugin>
    <groupId>io.github.beamliu</groupId>
    <artifactId>java-docs-json-doclet</artifactId>
    <version>0.1.1</version>
</plugin>

次に、実行します

mvn javadoc-json:javadoc-json

Maven の設定例は ./java-docs-json-doclet/examples/ にあります。

HTML Javadoc から：

READMEを参照してください。

ステップ 2：MCP サーバーを起動する

# 使用 npx（推荐，无需安装）
npx @io.emop/mcp-javadoc-server --javadoc-path /path/to/javadoc-json

mcp inspector を使用してテストします

npx @modelcontextprotocol/inspector npx -y @io.emop/mcp-javadoc-server -- --javadoc-path /path/to/javadoc-json

READMEを参照してください。

📖 使用例

設定が完了したら、Claude Desktop で次のコマンドを使用できます。

すべてのプロジェクトを検索：search_all("ArrayList")
クラスを検索：search_classes("HashMap")
メソッドを検索：search_methods("toString")
クラスの詳細を取得：get_class_details("java.util.List")
統計情報を取得：get_stats()

🔧 高度な設定

Lombok プロジェクト

Lombok を使用するプロジェクトでは、delombok 処理を設定します。

READMEを参照してください。

📄 ライセンス

本プロジェクトは MIT ライセンスを採用しています。

Markdown 対応

ログインしてコメント

MCP は初めてですか？

プロトコルの概要から最初のサーバーの導入まで、よくある疑問にまとめて答えます。

入門ガイドを読む

AI アプリケーションが外部のツールやデータソースに統一的な方法で接続するためのオープンなプロトコルです。クライアントはモデルとの対話を担い、MCP サーバーはツール・リソース・プロンプトテンプレートを提供します。標準メッセージでやり取りするため、1 つのサーバーを複数のクライアントで再利用できます。

Javadoc Mcp

Javadoc Mcp について

主な機能

活用シーン

MCP 対応

設定

ツール

詳細

MCP Java Documentation / MCP Java 文档

English

🚀 概要

🏗️ アーキテクチャ

📦 コンポーネント

1. Java Docs JSON Doclet (java-docs-json-doclet/)

2. MCP Server (mcp-server/)

3. Sample Data (javadoc-json/)

🚀 はじめに

ステップ 1：JSON ドキュメントを生成する

ステップ 2：MCP サーバーを起動する

📖 使用例

🔧 高度な設定

Lombok プロジェクト

📄 ライセンス

中国語

🚀 概要

🏗️ アーキテクチャ

📦 コンポーネント

1. Java Docs JSON Doclet (java-docs-json-doclet/)

2. MCP サーバー (mcp-server/)

3. サンプルデータ (javadoc-json/)

🚀 はじめに

ステップ 1：JSON ドキュメントを生成する

ステップ 2：MCP サーバーを起動する

📖 使用例

🔧 高度な設定

Lombok プロジェクト

📄 ライセンス

コメント

MCP は初めてですか？

MCP（Model Context Protocol）とは？

MCP サーバーとクライアントの違いは？

ローカルとリモート、どちらを選ぶべき？

Claude や Cursor にサーバーを導入するには？

掲載プロジェクトは審査されていますか？「認証済み」とは？

自分のプロジェクトが掲載されています。どう申請できますか？

1. Java Docs JSON Doclet (`java-docs-json-doclet/`)

2. MCP Server (`mcp-server/`)

3. Sample Data (`javadoc-json/`)

1. Java Docs JSON Doclet (`java-docs-json-doclet/`)

2. MCP サーバー (`mcp-server/`)

3. サンプルデータ (`javadoc-json/`)