Javadoc Mcp

Name: Javadoc Mcp
Author: loong95

@loong95

代码仓库

关于 Javadoc Mcp

让 AI 助手能够通过 Maven 坐标浏览 JavaDoc 文档

#java #javadoc

基本信息

分类

其他

传输方式

stdio

发布者

loong95

提交者

云龙林

配置

使用下面的配置,将此服务器添加到你的 MCP 客户端。

{
  "mcpServers": {
    "javadoc": {
      "command": "npx",
      "args": [
        "-y",
        "javadoc-mcp"
      ]
    }
  }
}

工具

未检测到工具

工具是从 README 中自动提取的。维护者可以在 ## Tools 标题下列出工具,即可填充这部分内容。

概览

What is Javadoc Mcp?

Javadoc Mcp is a Model Context Protocol (MCP) server that allows AI assistants to browse JavaDoc documentation using Maven coordinates. It is designed for developers who need programmatic access to Java library documentation via an AI or CLI tool.

How to use Javadoc Mcp?

Install via npx -y javadoc-mcp or npm install -g javadoc-mcp, then configure your MCP client (e.g., Claude Code or Claude Desktop) with the appropriate command and arguments in settings.json or claude_desktop_config.json. After setup, tools are automatically available to the AI assistant.

Key features of Javadoc Mcp

Five MCP tools for browsing JavaDoc: list_packages, list_classes, get_class, get_member, and search.
Reads from the local Maven repository (~/.m2/repository) or auto-fetches missing -javadoc.jar files.
Uses cheerio for HTML parsing and adm-zip to read directly from JARs without extracting to disk.
Implemented in TypeScript with the @modelcontextprotocol/sdk.

Use cases of Javadoc Mcp

An AI assistant looks up a class’s method signatures and documentation while writing Java code.
A developer searches for a specific type or member across multiple Java libraries.
Automated tooling browses the package structure of a Maven artifact to generate API summaries.

FAQ from Javadoc Mcp

What are the system requirements?

Node.js 18+ is required, and the mvn command must be available in PATH.

Where are JavaDoc JARs stored locally?

Javadoc Mcp uses the local Maven repository, typically located at ~/.m2/repository, or the path specified in ~/.m2/settings.xml under <localRepository>.

How do I refresh the documentation for a library?

Delete the corresponding *-javadoc.jar from your local Maven repository for that artifact; the server will fetch it again on the next invocation.

How is Javadoc Mcp configured with MCP clients?

Add a server entry to your MCP client configuration (e.g., ~/.claude/settings.json or claude_desktop_config.json) with "command": "npx" and "args": ["-y", "javadoc-mcp"], or "command": "javadoc-mcp" if globally installed.