Javadoc Mcp

MCP其他

提供方 loong95 · 包名 javadoc-mcp

其他 stdio · 本地进程 会话登录 社区 / 第三方 Claude DesktopClaudeCursorCodex
查看接入方式

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

一句话选型结论

按资料字段整理

Javadoc Mcp 属于其他类 MCP 服务器,stdio · 本地进程,会话登录,可直接接入 Claude Desktop、Claude、Cursor 等,有可直接执行的安装命令。接入前先确认权限范围;涉及写入、删除或付款的操作,建议先在测试环境验证。

分类其他 传输方式stdio · 本地进程 鉴权会话登录 部署方式本地部署
GitHub 星标 未标注 仓库热度,无公开仓库时显示未标注
工具数 未标注 暴露给模型的工具数量
资源 / 提示词 0 / 0 资源与提示词模板数量
维护方 社区 / 第三方 核验等级 仅资料核对

工具与能力

其他
数量来自来源目录的标注,具体工具清单以官方文档为准
工具数量未标注暴露给模型可调用的工具个数
资源数量0可读取的资源条目
提示词数量0内置提示词模板数量

能力标签

支持客户端

适用场景

java

安装与配置

stdio · 本地进程 会话登录
客户端在本机拉起子进程,数据不出本机
npx -y javadoc-mcp\r

这条命令只是入口,具体启动参数请按官方文档补齐,不要直接照搬到别的服务器。

  1. 1
    准备运行环境

    stdio 服务在本地起进程,需要先装好 Cross-platform,再按安装命令拉取依赖。

  2. 2
    安装服务

    复制上面的安装命令执行;命令里带占位符的位置,换成自己的密钥或路径。

  3. 3
    写入客户端配置

    在客户端的 MCP 配置里填好启动命令和参数,保存后完全退出客户端再打开,让新配置生效。

  4. 4
    验证是否可用

    连接成功后随便调一个只读工具,确认能返回结果,再接入正式流程。

典型使用场景

3 类
按分类与标签整理的常见用法,具体以官方文档为准
接入外部数据

把外部系统的数据接进对话。

自动化重复操作

把固定步骤交给模型跑。

补充工具能力

给模型补上它原本没有的能力。

选择建议

选之前先看这几条
按条目字段给出的判断,不替你决定用不用

值得选的地方

  • 有现成的安装命令,不用自己找入口,照着跑就能起服务。
  • 已适配 Claude Desktop、Claude、Cursor,换客户端不用重新研究配置。

先想清楚的地方

  • stdio 方式要求本地装好运行时(如 Node.js),换机器要重新装一遍。
  • 使用前要准备好会话登录对应的凭据,并按最小权限配置。
  • 资料没标注工具数量,实际能力要装好后确认。
  • 版本更新与行为细节以官方仓库为准。

更适合

  • 需要在其他场景里让模型直接调用外部能力的人。
  • 已经在用 Claude Desktop、Claude 的用户,接入路径最短。
  • 想先快速试一下、能接受在本地或自有环境跑服务的人。

不太适合

  • 完全不想在本地装环境的人。
  • 不方便管理密钥或第三方授权的人。
  • 需要厂商级 SLA 和技术支持的生产环境。

同类对比

6 个同类
同分类里挑最接近的几条,字段以各自详情页为准
MCP 服务器工具数传输方式部署方式安装命令最后核验
Javadoc Mcp当前 未标注 stdio · 本地进程 本地部署 有 未标注
gemini-cli 未标注 stdio · 本地进程 本地部署 有 2026-04-13
ext-apps 未标注 stdio · 本地进程 本地部署 有 2026-04-19
northcinder 未标注 stdio · 本地进程 本地部署 有 2026-08-23
fastctx 未标注 stdio · 本地进程 本地部署 有 2026-08-23
quickstart-resources 未标注 stdio · 本地进程 本地部署 有 2026-04-12

服务器档案

其他
字段来自项目仓库与公开索引,中文说明由本站标注
提供方loong95上游标注的维护方 loong95
分类其他本站按上游分类展示
连接方式stdio · 本地进程客户端在本机拉起子进程,数据不出本机
鉴权方式会话登录远程服务建议用最小权限凭据
维护方社区 / 第三方核验等级 仅资料核对
包名 / 运行时javadoc-mcp · Cross-platform本地安装时用到的包标识与运行时
部署类型本地部署上游给出的部署形态
最近核验未标注上游最后核验时间

详细介绍

4.6 KB
来自项目仓库与上游目录的原文,未做删改

javadoc-mcp

一个同时提供 MCP 服务和 Shell CLI 的工具,让 AI 助手或终端用户能够通过 Maven 坐标浏览 JavaDoc 文档。

发布记录见 CHANGELOG.md。

功能

提供 5 个 JavaDoc 浏览能力,既可通过 MCP tools 调用,也可通过 CLI 子命令调用:

Tool 说明
list_packages 列出库中所有包
list_classes 列出包中的类、接口、枚举、注解、异常、record
get_class 获取类概览文档(签名、描述、成员摘要)
get_member 获取方法/字段的完整文档(参数、返回值、异常等)
search 按关键词搜索类型、成员或包;category 可省略,type/member 结果会显示完整类名并支持完整限定名查询

运行要求

  • Node.js 18+
  • Maven (mvn 需要在 PATH 中可用)

服务会优先读取本地 Maven 仓库中的 JavaDoc JAR;如果缺失,则通过 mvn dependency:get 拉取对应的 -javadoc.jar。

安装

安装后会提供两个可执行文件:

  • javadoc-mcp:启动 MCP 服务
  • javadoc-cli:在 shell 中直接查询 JavaDoc

方式一:直接通过 npx 使用 MCP```bash

npx -y javadoc-mcp


### 方式二:全局安装```bash
npm install -g javadoc-mcp

安装完成后,可直接运行:```bash
javadoc-mcp


也可以直接在 shell 中调用 CLI:```bash
javadoc-cli --help

如果不想全局安装,可以通过 npx 临时调用 CLI:```bash
npx -y -p javadoc-mcp javadoc-cli --help


当前版本已经覆盖 `npx` 和其他符号链接路径下的 CLI 启动场景。

## 配置 MCP 客户端

### Claude Code

推荐直接通过 `npx` 启动,这样不需要手动管理安装路径:

编辑 `~/.claude/settings.json`:```json
{
  "mcpServers": {
    "javadoc": {
      "command": "npx",
      "args": ["-y", "javadoc-mcp"]
    }
  }
}

如果你已经全局安装,也可以写成:```json
{
"mcpServers": {
"javadoc": {
"command": "javadoc-mcp",
"args": []
}
}
}


### Claude Desktop

编辑 `claude_desktop_config.json`:```json
{
  "mcpServers": {
    "javadoc": {
      "command": "npx",
      "args": ["-y", "javadoc-mcp"]
    }
  }
}

从源码开发```bash

npm install
npm run build
npm test


构建产物输出到 `dist/` 目录。

本地开发时也可以直接运行 CLI:```bash
node dist/cli.js --help

调试

使用 MCP Inspector 进行交互式测试:```bash
npx @modelcontextprotocol/inspector node dist/index.js


## 使用示例

### CLI```bash
javadoc-cli list-packages \
  --group-id org.apache.commons \
  --artifact-id commons-lang3 \
  --version 3.14.0

javadoc-cli list-classes \
  --group-id org.apache.commons \
  --artifact-id commons-lang3 \
  --version 3.14.0 \
  --package-name org.apache.commons.lang3

javadoc-cli get-class \
  --group-id org.apache.commons \
  --artifact-id commons-lang3 \
  --version 3.14.0 \
  --class-name org.apache.commons.lang3.StringUtils

javadoc-cli get-member \
  --group-id org.apache.commons \
  --artifact-id commons-lang3 \
  --version 3.14.0 \
  --class-name org.apache.commons.lang3.StringUtils \
  --member-name join

javadoc-cli search \
  --group-id org.apache.commons \
  --artifact-id commons-lang3 \
  --version 3.14.0 \
  --query String \
  --category type

MCP

典型的浏览流程:```
1. list_packages(groupId="org.apache.commons", artifactId="commons-lang3", version="3.14.0")
→ 获取所有包名

  1. list_classes(..., packageName="org.apache.commons.lang3")
    → 查看包中的类型列表

  2. get_class(..., className="org.apache.commons.lang3.StringUtils")
    → 查看 StringUtils 类的概览和方法摘要

  3. get_member(..., className="org.apache.commons.lang3.StringUtils", memberName="join")
    → 查看 join 方法的完整文档

  4. search(..., query="String", category="type")
    → 搜索名称或完整类名含 "String" 的类型

  5. search(..., query="org.apache.commons.lang3.StringUtils.join")
    → 在未指定 category 时跨类型/成员/包搜索,按完整成员引用查找成员
    ```

本地仓库

JavaDoc JAR 直接使用 Maven 本地仓库中的文件,默认路径为 ~/.m2/repository。如果 ~/.m2/settings.xml 中配置了 ``,则使用该路径。

如需重新拉取某个文档,可删除对应坐标下的 *-javadoc.jar 后再次调用工具。

技术栈

  • TypeScript (ES Modules)
  • @modelcontextprotocol/sdk — MCP 协议实现
  • cheerio — HTML 解析
  • adm-zip — 直接从 JAR 读取文件,不解压到磁盘
  • zod — 参数校验

仓库与反馈

  • GitHub: https://github.com/loong95/javadoc-mcp
  • Issues: https://github.com/loong95/javadoc-mcp/issues

常见问题

8 问
答案由本站依据条目字段整理,不引用上游原文
Javadoc Mcp 怎么安装?

在客户端按下面的安装命令接入:npx -y javadoc-mcp\r。对应的包名是 javadoc-mcp。装完在客户端配置里引用同一个包或端点。

Javadoc Mcp 怎么在 Claude Desktop、Claude、Cursor 里配置?

它的传输方式是stdio · 本地进程,在客户端的 MCP 配置里填好启动命令和参数,保存后完全退出客户端再打开,配置才会生效。

Javadoc Mcp 收费吗?

本站不代收费用,也没有标注具体价格。是否收费取决于服务本身和背后的接口额度,正式使用前按官方说明确认。

Javadoc Mcp 需要 API Key 吗?

资料标注需要会话登录认证,使用前准备好对应凭据,并按最小权限配置。

Javadoc Mcp 支持哪些客户端?

资料标注支持 Claude Desktop、Claude、Cursor、Codex、Zed;其他客户端只要能配置 MCP Server,也能用同样的命令或地址接入。

Javadoc Mcp 能提供哪些能力?

资料显示能力标签包括 java。具体工具清单以官方文档为准。

Javadoc Mcp 需要什么运行环境?

运行时为 Cross-platform;属于本地进程,需要在本机装好运行环境。

Javadoc Mcp 是本地还是远程?

它是本地进程(stdio),由客户端在本机拉起。传输方式为stdio · 本地进程。

热门专题

按标签挑服务器
全部专题 →

服务器信息以作者仓库与官方文档为准;分类、传输方式与鉴权方式的中文说明为中文整理,最近核验 未标注。