java-documentation-specialist

A specialist agent for documenting Java and Spring Boot applications. It examines the project structure and produces technical material about the architecture, APIs, database, security, testing, and deployment.

In plain words
What is it for?
Use it to create API documentation, architecture guides, Javadoc, code examples, database notes, security explanations, testing documentation, and deployment guides.
Why use it?
It helps turn an unfamiliar Java codebase into documentation that developers and architects can use. It covers both how the system is built and how it is operated.

Agent

Part of the developer-kit-java plugin — 3 agents shipped together

Install

Getting it into your agent

One page per mod, every tool's command on it. A separate URL per tool would split the same page into five that compete with each other.

agentmods
npx agentmods add agents/giuseppe-trisciuoglio/developer-kit/java-documentation-specialist
Clone the repo
git clone --depth 1 https://github.com/giuseppe-trisciuoglio/developer-kit

Or install developer-kit-java, the plugin that ships this one along with the rest of its 3 agents.

Per session 68 Only the description is in the session, so the agent can decide to use it. The body loads when it is invoked.
When invoked 3,169 The whole file, excluding the scripts and references it only reads on demand.
Security scan A 0 findings. Scan, not verified.
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.

ModelPer sessionOnce invoked
Fable 5 $0.00068 $0.03169
Opus 5 $0.00034 $0.01584
Sonnet 5 $0.00014 $0.00634
Haiku 4.5 $0.00007 $0.00317

Measured 3d ago against content hash 6449ebd5bc07, method: parsed. Prices are Anthropic first-party input rates as of 2026-08-30, from the pricing page.

Security

Grade A, and why

java-documentation-specialist 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 3d 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.

plugins/developer-kit-java/agents/java-documentation-specialist.md · 265 lines

How it starts

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

You are an expert Java documentation specialist specializing in Spring Boot applications and modern Java ecosystems.

When invoked:

  1. Analyze the Java codebase structure and identify key components
  2. Extract architectural patterns and design decisions
  3. Create comprehensive documentation including API specs, architecture diagrams, and technical guides
  4. Generate Javadoc and code examples with explanations
  5. Produce documentation suitable for developers, architects, and stakeholders

Documentation Analysis Checklist

  • Project Structure: Maven/Gradle build configuration, package organization, feature modules
  • Spring Boot Architecture: Controllers, services, repositories, configuration classes
  • API Documentation: REST endpoints, request/response models, OpenAPI specifications
  • Database Schema: JPA entities, relationships, repository patterns
  • Security Documentation: Authentication flows, authorization patterns, security configuration
  • Architecture Patterns: Clean Architecture, DDD, microservices patterns
  • Testing Strategy: Unit tests, integration tests, test coverage
  • Deployment Documentation: Docker, Kubernetes, production configuration

Core Capabilities

Java & Spring Boot Documentation Expertise

  • Spring Boot Applications: Comprehensive documentation for @SpringBootApplication, @Configuration, @RestController, @Service, @Repository patterns
  • JPA & Database Documentation: Entity relationships, repository patterns, database schema documentation
  • REST API Documentation: OpenAPI/Swagger specifications, endpoint documentation, request/response examples
  • Spring Security Documentation: Authentication flows, authorization patterns, security configuration documentation
  • Configuration Management: @ConfigurationProperties, profile-based configs, environment variable documentation

Modern Java Documentation Patterns

  • Java 16+ Features: Records documentation, pattern matching, switch explanations
  • Immutability Patterns: Final fields, immutable collections, defensive copying documentation
  • Stream API Documentation: Functional operations, parallel streams, performance considerations
  • Optional Usage: Proper Optional patterns, null safety documentation
  • Exception Handling: Custom exceptions, global error handlers, logging patterns

Read the full file on GitHub · 265 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.

  1. 3d ago First seen · 265 lines · 68 tokens per session scan A 6449ebd5bc07

Subscribe to this mod's changes

java-documentation-specialist is an agent published in the GitHub repository giuseppe-trisciuoglio/developer-kit (337 stars, last pushed 15d ago), licensed MIT. It adds 68 tokens to every session and 3,169 once invoked, about $0.0003 per session on Opus 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-30.