Javadoc Mcp

Name: Javadoc Mcp
Author: BeamLiu

@BeamLiu

Repository

About Javadoc Mcp

No overview available yet

#javadoc #java-docs #documentation-generator

Basic information

Config

Add this server to your MCP-compatible client using the configuration below.

{
  "mcpServers": {
    "javadoc-search": {
      "command": "npx",
      "args": [
        "-y",
        "@io.emop/mcp-javadoc-server",
        "--javadoc-path",
        "/absolute/path/to/javadoc-json"
      ]
    }
  }
}

Tools

Search for classes, methods, constructors, and fields in the JavaDocs

Search specifically for classes and interfaces

Search specifically for methods and constructors

Search specifically for fields/properties

Get detailed information about a specific class

Get statistics about the loaded JavaDoc data

Overview

What is Javadoc Mcp?

Javadoc Mcp is a Node.js-based MCP server that provides intelligent search capabilities for Java documentation in structured JSON format, enabling seamless integration with AI assistants like Claude Desktop.

How to use Javadoc Mcp?

Generate JSON documentation from Java source code using the accompanying Maven plugin (java-docs-json-doclet) or by crawling HTML Javadoc, then start the MCP server with npx @io.emop/mcp-javadoc-server --javadoc-path /path/to/javadoc-json; use commands like search_all("ArrayList"), search_classes("HashMap"), or get_stats() in Claude Desktop.

Key features of Javadoc Mcp

Fuzzy search powered by Fuse.js
Multiple search types: classes, methods, constructors, fields
Automatic data deduplication and merging
Documentation statistics and coverage overview
Direct integration with Claude Desktop

Use cases of Javadoc Mcp

Searching Java API documentation through an AI assistant
Querying structured documentation for specific classes and methods
Getting an overview of documented packages and their coverage
Exploring generated JSON docs from source code or HTML Javadoc

FAQ from Javadoc Mcp

What data does Javadoc Mcp require?

It requires pre-generated JSON documentation files created by the java-docs-json-doclet Maven plugin, either from Java source code or crawled from HTML Javadoc websites.

What Java versions are supported for generating input JSON?

The javadoc-json goal supports Java 8 and above; the crawl goal currently supports JDK 9 (with future version plans).

Does Javadoc Mcp support projects using Lombok?

Yes, the Maven plugin supports Lombok annotations via a delombok process; configuration details are in the plugin’s README.

How can I test the MCP server?

Use the mcp inspector tool: run npx @modelcontextprotocol/inspector npx -y @io.emop/mcp-javadoc-server -- --javadoc-path /path/to/javadoc-json.

Are there any transport or authentication requirements?

The README does not specify transports or authentication; the server expects a local file path for JSON data and is designed for use with MCP-compatible clients like Claude Desktop.