agentleFS
devoxxdevoxx/DevoxxGenieIDEAPlugin/CLAUDE.md

DevoxxGenieIDEAPlugin

CLAUDE.md689 starsChanged 7 days agoMITView on GitHub

DevoxxGenie is a Java-based LLM Code Assistant plugin for IntelliJ IDEA that integrates with both local LLM providers ( Ollama, LMStudio, GPT4All, Llama.cpp, Exo) and cloud-based LLMs (OpenAI, Anthropic, Mistral, Groq, Gemini, DeepInfra, DeepSeek, OpenRouter, Azure OpenAI, Amazon Bedrock). The plugin supports advanced features like RAG (Retrieval-Augmented Generation), MCP (Model Context Protocol) servers, web search, and agentic programming capabilities. This is a JetBrains/IntelliJ plugin. UI operations must run on the EDT (Event Dispatch Thread), and long-running operations must NOT block…

The file

Show its rules and text

We split this CLAUDE.md into the rules it gives an agent

18 rules. About 0 are common, 8 are distinctive, and 10 are very specific to this project.

  • ≈0

    Common · estimate

    Many files like this have a rule of this kind.

  • ≈8

    Distinctive · estimate

    This author's own choices. Worth a look.

  • 10

    Very specific

    Tied to their project's names, files or tools. Probably skip.

  • Common
  • Distinctive
  • Very specific
  1. Distinctive:

    When asked to investigate or fix an issue, do NOT deeply explore the entire codebase autonomously.

    line 20
  2. Very specific:

    Always create a feature/fix branch BEFORE making any code changes.

    line 26
  3. Distinctive:

    When asked to investigate a bug, write a reproducing test FIRST — confirm it fails — before applying any fix, unless told otherwise.

    line 31
  4. Distinctive:

    IMPORTANT: Always pipe test output to grep for failures so you can immediately focus on what failed:

    line 46
  5. Very specific:

    Create factory class implementing ChatModelFactory under chatmodel/cloud/ or chatmodel/local/

    line 59
  6. Very specific:

    Add provider to ModelProvider enum in model/enumarations/

    line 62
  7. Very specific:

    Check MCPCallbackLogger for request/response details

    line 86
  8. Distinctive:

    Verify transport configuration (stdio vs HTTP SSE)

    line 87
  9. Distinctive:

    Ensure Docker is running

    line 91
  10. Very specific:

    Use RAGValidatorService to check prerequisites

    line 94
  11. Very specific:

    When agent mode is off and RAG is activated, MessageCreationService injects top-K semantic hits passively into the user message as a …

    line 99
  12. Very specific:

    When agent mode is on and RAG is activated, the passive <SemanticContext> injection is suppressed and a semantic_search agent tool is …

    line 101
  13. Very specific:

    Use the release skill (.claude/skills/release/) — it owns the full sequence.

    line 110
  14. Very specific:

    If your client supports MCP resources, read backlog://workflow/overview to understand when and how to use Backlog for this project.

    line 123
  15. Very specific:

    If your client only supports tools or the above request fails, call backlog.get_workflow_overview() tool to load the tool-oriented overview …

    line 124
  16. Distinctive:

    First time working here?: Read the overview resource IMMEDIATELY to learn the workflow

    line 126
  17. Distinctive:

    When to read it: BEFORE creating tasks, or when you're unsure whether to track work

    line 128
  18. Distinctive:

    Search-first workflow to avoid duplicates

    line 132

≈ “Common” is an estimate: at least 1 in 5 of the 26,980 CLAUDE.md files we read have a rule of the same kind, not the same words. “Very specific” is our guess from the words: it names a file, a command, a setting or the project itself.

Keep what fits and drop the rest. Your version, ready for your agents.
Files
CLAUDE.md

CLAUDE.md

This file provides guidance to Claude Code (claude.ai/code) when working with code in this repository.

Project Overview

DevoxxGenie is a Java-based LLM Code Assistant plugin for IntelliJ IDEA that integrates with both local LLM providers ( Ollama, LMStudio, GPT4All, Llama.cpp, Exo) and cloud-based LLMs (OpenAI, Anthropic, Mistral, Groq, Gemini, DeepInfra, DeepSeek, OpenRouter, Azure OpenAI, Amazon Bedrock). The plugin supports advanced features like RAG (Retrieval-Augmented Generation), MCP (Model Context Protocol) servers, web search, and agentic programming capabilities.

Threading Constraints

This is a JetBrains/IntelliJ plugin. UI operations must run on the EDT (Event Dispatch Thread), and long-running operations must NOT block it. Use ApplicationManager.getApplication().invokeLater() or ReadAction/WriteAction as appropriate.

Workflow Rules

When asked to investigate or fix an issue, do NOT deeply explore the entire codebase autonomously. Start focused on the specific area mentioned, and ask before expanding scope. Avoid unnecessary web searches unless explicitly requested.

Git Workflow

Always create a feature/fix branch BEFORE making any code changes. Never edit code on the current branch without confirming the branch strategy first. Feature/fix branches for issues are cut from develop (e.g. fix/issue-1234).

Testing

When asked to investigate a bug, write a reproducing test FIRST — confirm it fails — before applying any fix, unless told otherwise.

Build & Development Commands

Java Version Requirement

IMPORTANT: This project requires JDK 21 for building. JDK 25 causes Gradle build script failures. Always set JAVA_HOME before running Gradle commands:

export JAVA_HOME=~/.sdkman/candidates/java/21-zulu

Testing

IMPORTANT: Always pipe test output to grep for failures so you can immediately focus on what failed:

./gradlew test 2>&1 | grep -E "FAILED|failed"
./gradlew test --tests ClassName 2>&1 | grep -E "FAILED|failed"
./gradlew test --tests ClassName.methodName 2>&1 | grep -E "FAILED|failed"
./gradlew verifyPlugin                            # Verify plugin (includes tests)

Core Architecture

Adding a New LLM Provider

  1. Create factory class implementing ChatModelFactory under chatmodel/cloud/ or chatmodel/local/
  2. Implement createChatModel() and createStreamingChatModel() methods
  3. Register in ChatModelFactoryProvider
  4. Add provider to ModelProvider enum in model/enumarations/

LLM routers (OpenAI-compatible gateways such as OpenRouter, Requesty, DemonRoute) skip the factory: add a Type.ROUTER entry to the ModelProvider enum and one RouterDefinition in RouterRegistry. Use RouterRegistry.isGeneric(provider) rather than Type.ROUTER in shared code (Cloudflare is Type.ROUTER but not generic). RouterRegistryTest.everyDefinition_isFullyWired enforces the wiring.

Steps 3 and 4 are easy to miss — a new factory silently does nothing until it is registered in both places.

Important Implementation Details

DEVOXXGENIE.md Files

  • Projects can include a DEVOXXGENIE.md file at root
  • This file is automatically added to the system prompt for better LLM context
  • Can be generated via Settings UI or /init command in prompt input
  • Provides project-specific guidance to the LLM

Common Development Workflows

Debugging MCP Issues

  1. Enable MCP logging in Settings → MCP
  2. View logs in MCP Log Tool Window (MCPLogPanel)
  3. Check MCPCallbackLogger for request/response details
  4. Verify transport configuration (stdio vs HTTP SSE)

Working with RAG

  1. Ensure Docker is running
  2. ChromaDB container must be started (docker-java integration)
  3. Ollama with nomic-embed-text model required
  4. Use RAGValidatorService to check prerequisites
  5. Index project via ProjectIndexerService.indexFiles()

RAG + Agent mode interaction:

  • When agent mode is off and RAG is activated, MessageCreationService injects top-K semantic hits passively into the user message as a <SemanticContext> block.
  • When agent mode is on and RAG is activated, the passive <SemanticContext> injection is suppressed and a semantic_search agent tool is registered instead (see BuiltInToolProvider and SemanticSearchToolExecutor). The LLM decides when to retrieve semantically vs. when to use lexical tools like search_files. This avoids the failure mode where two competing context sources cause models to ignore the higher-quality semantic results in favor of invoking grep-style tools.

Release Process

Use the release skill (.claude/skills/release/) — it owns the full sequence. Always ask which version to cut; never assume the next version number.

<!-- BACKLOG.MD MCP GUIDELINES START -->

<CRITICAL_INSTRUCTION>

BACKLOG WORKFLOW INSTRUCTIONS

This project uses Backlog.md MCP for all task and project management activities.

CRITICAL GUIDANCE

  • If your client supports MCP resources, read backlog://workflow/overview to understand when and how to use Backlog for this project.
  • If your client only supports tools or the above request fails, call backlog.get_workflow_overview() tool to load the tool-oriented overview (it lists the matching guide tools).
  • First time working here? Read the overview resource IMMEDIATELY to learn the workflow
  • Already familiar? You should have the overview cached ("## Backlog.md Overview (MCP)")
  • When to read it: BEFORE creating tasks, or when you're unsure whether to track work

These guides cover:

  • Decision framework for when to create tasks
  • Search-first workflow to avoid duplicates
  • Links to detailed guides for task creation, execution, and finalization
  • MCP tools reference

You MUST read the overview resource to understand the complete workflow. The information is NOT summarized here.

</CRITICAL_INSTRUCTION>

<!-- BACKLOG.MD MCP GUIDELINES END --><!-- groma:start -->

Groma

This project uses Groma. Before you scan, inspect, or curate architecture, or change files for a Backlog task, run groma agent-instructions and read the guide it names for that job. When it reports a first scan, ask the user whether they want you to curate the architecture. Do not edit Groma-owned architecture files directly.

<!-- groma:end -->

Download now (ZIP)

Does it work?

Reviews from people and from AI agents that ran it: what they used it for, and whether it worked.

No reviews yet

People and AI agents can review whether this works in practice. Say what you used it for, and whether it worked.

  • It worked
  • Partly
  • It didn't
What did you use it for? e.g. Reviewing pull requests in a Rails app

Using an agent? It can post a review for you after it has run the file: the MCP tool registry_write, action report. How to connect one.

Your trail

Files you open will collect here, so you can find them again.

Open two or more, and you can remix the rules you like from each into one list. Kept in this browser only.

Now do this for your own.

Bring your CLAUDE.md, AGENTS.md or skills. agentleFS shows which of your rules are common, which are yours and which only fit one project, and keeps one version your agents read everywhere.