What is javadoc-mcp AGENTS.md?

A repository guide for the `javadoc-mcp` project, an MCP server that fetches and parses Java documentation. It describes the project layout, build and development commands, coding style, and testing rules.

Use it when developing or reviewing `javadoc-mcp`, including changes under `src/`, TypeScript builds, local development, and interactive MCP inspection.

It gives contributors the project-specific instructions needed to change the code consistently and run the right checks. It also warns that generated `dist/` files should not be edited directly.

How loong95/javadoc-mcp configures Codex and OpenCode

Reuse

Borrowing it

Nothing to install: this file belongs to loong95/javadoc-mcp. Take a copy, put it at the same path in your own repository, and replace the rules that are about this project with yours.

Copy the file

curl -O https://raw.githubusercontent.com/loong95/javadoc-mcp/main/AGENTS.md

Clone the repo

git clone --depth 1 https://github.com/loong95/javadoc-mcp

Made for: Codex, OpenCode.

Wrote this? Show the measurements

A badge with what this costs and how it scanned, read live from this page, so it follows the numbers instead of freezing them. Markdown for a README, HTML for a documentation site or a project page.

README.md

[![agentmods](https://agentmods.dev/badge/instructions/loong95/javadoc-mcp/agents-md/github.svg)](https://agentmods.dev/instructions/loong95/javadoc-mcp/agents-md)

Your own site

<a href="https://agentmods.dev/instructions/loong95/javadoc-mcp/agents-md"><img src="https://agentmods.dev/badge/instructions/loong95/javadoc-mcp/agents-md/github.svg" alt="Measured on agentmods" height="20"></a>

Or the 80×15 button, for a site that already has a row of RSS and ATOM ones. Only the verdict fits; the numbers stay here.

Your own site · 80×15

<a href="https://agentmods.dev/instructions/loong95/javadoc-mcp/agents-md"><img src="https://agentmods.dev/badge/instructions/loong95/javadoc-mcp/agents-md.svg" alt="Reviewed on agentmods" width="80" height="20"></a>

Per session 530 This file is loaded in full into every session.

When invoked 530 The same file — it is already loaded in full.

Security scan A 0 findings. A grade says what 26 rules found in the file — not that it is safe.

Origin original No closer match found in the catalogue.

Token cost

What it costs to keep this loaded

Counted locally with the o200k_base tokenizer, which is exact for GPT models; Claude uses its own tokenizer and its counts differ. Treat this as one consistent yardstick across the catalogue rather than a bill. Prices are per million input tokens.

Model	Per session	Once invoked
Fable 5.1	$0.00530	$0.00530
Opus 5.5	$0.00212	$0.00212
Sonnet 5.5	$0.00106	$0.00106
Haiku 4.5	$0.00053	$0.00053

Measured 2mo ago against content hash 60b8303e3a23, method: parsed. Prices are Anthropic first-party input rates as of 2026-10-07, from the pricing page.

Security

Grade A, and why

javadoc-mcp AGENTS.md scanned grade A with 0 findings against 26 rules in 11 categories — prompt injection, anti-refusal, data exfiltration, privilege escalation, supply chain, agent snooping, system-prompt leakage, SSRF and excessive agency — measured 2mo ago.

A static scan of the body, not an audit. Every finding is printed with the line that produced it so you can judge whether it matters here. A mod is markdown that instructs an agent; that is exactly why what it instructs is worth reading.

Nothing flagged

None of the 26 patterns this scan looks for appear in this file: no shell pipes, no recursive deletes, no credential paths, no hidden text, no instruction-override or anti-refusal phrasing, no agent-config snooping. That is not a guarantee, it is the absence of the things that are checkable.

AGENTS.md · 27 lines

How it starts

The opening of the file, as written. The whole thing — 27 lines — stays where its author put it; the contents beside it link to each section on GitHub.

Repository Guidelines

Project Structure & Module Organization

Source lives under src/. src/index.ts boots the MCP server and registers tools. Tool entrypoints are in src/tools/ (list-packages.ts, get-class.ts, etc.), while JavaDoc fetching and parsing logic lives in src/javadoc/. Shared types are defined in src/types.ts. Build output is generated into dist/; treat that directory as disposable and do not edit it by hand.

Build, Test, and Development Commands

Install dependencies with npm install.

npm run build: compile TypeScript from src/ to dist/ with declarations and source maps.
npm start: run the built MCP server from dist/index.js.
npm run dev: run the TypeScript compiler in watch mode during development.
npx @modelcontextprotocol/inspector node dist/index.js: inspect the server interactively after a build.

Use Node.js 18+ as noted in the README.

Coding Style & Naming Conventions

Follow the existing TypeScript style in src/: 2-space indentation, semicolons, ES module imports with explicit .js extensions, and strict typing. Prefer small, focused modules and named exports. Keep MCP tool files in kebab-case (get-member.ts) and exported functions in camelCase (getMember). Reuse Zod schemas for tool inputs and keep parsing logic isolated in src/javadoc/.

Testing Guidelines

This checkout does not include an automated test suite yet, and package.json currently defines no test script. For changes that affect parsing or resolution, add focused tests before expanding functionality, and document manual verification steps in the PR. At minimum, verify npm run build succeeds and smoke-test one Maven coordinate through MCP Inspector.

Commit & Pull Request Guidelines

Local Git history is not available in this workspace, so no repository-specific commit convention can be inferred here. Use short, imperative commit subjects such as Add fallback for legacy package lists. Keep commits scoped to one change. PRs should describe the user-visible effect, list verification steps, and note any Maven artifacts or JavaDoc variants used for testing. Include screenshots only when UI tooling output makes review clearer.

Read the full file on GitHub · 27 lines

Changes

What this file has done since we first saw it

Hashed on every crawl. A supply-chain change to an agent config is a question of when, not whether, so the history is kept rather than the latest state alone.

2mo ago First seen · 27 lines · 530 tokens per session scan A 60b8303e3a23

Subscribe to this mod's changes

javadoc-mcp AGENTS.md is an instructions file published in the GitHub repository loong95/javadoc-mcp (4 stars, last pushed 5mo ago), licensed Apache-2.0. It adds 530 tokens to every session, about $0.0021 per session on Opus 5.5. A static security scan graded it A with 0 findings. No closer match exists in the catalogue, so it is treated as the original; first seen 2026-08-31.

javadoc-mcp AGENTS.md next to 6 instructions from other repositories
Mod	Type	Stars	Last push	Licence	Scan	Tokens	Works with
javadoc-mcp AGENTS.mdloong95/javadoc-mcp	Instructions file	4	5mo ago	Apache-2.0	A	530	Codex, OpenCode
vscode buildNext.instructions.mdmicrosoft/vscode	Instructions file	195k	yesterday	MIT	A	9,719	GitHub Copilot
next.js AGENTS.mdvercel/next.js	Instructions file	143k	today	MIT	A	7,461	Codex, OpenCode
langchain AGENTS.mdlangchain-ai/langchain	Instructions file	149k	yesterday	MIT	A	4,680	Codex, OpenCode
vscode oss-third-party-notices.instructions.mdmicrosoft/vscode	Instructions file	195k	yesterday	MIT	A	5,516	GitHub Copilot
vscode copilot-instructions.mdmicrosoft/vscode	Instructions file	195k	yesterday	MIT	A	3,093	GitHub Copilot
deepseek-harness AGENTS.mddeepseek-ai/deepseek-harness	Instructions file	274k	2d ago	MIT	A	4,313	Codex, OpenCode

javadoc-mcp: Instructions file for Codex