AI Agent Setup

This page shows how to set up a Jmix project for an AI coding agent.

The agent works in a project that is open in Jmix Studio and uses the IDE to check the code it writes. You use Studio to check what the agent did, run the application and make your own changes.

Setup Steps

  1. Install the AI coding agent that you want to use, for example Claude Code, Codex or OpenCode.

  2. Install Studio and the JDK as described in the Setup section.

  3. Enable the MCP server in IntelliJ IDEA: open Settings → Tools → MCP Server and select Enable MCP Server.

  4. Create a project with the Jmix Agent Toolkit in one of the following ways.

  5. Run the agent in the project folder and make sure Jmix skills and MCP servers are available to the agent.

    • Enter the /skills command and check that jmix* skills are available.

    • Enter the /mcp command and check that the following MCP servers are connected:

      • jetbrains

      • context7, jmix-docs (at least one of them; both are used to get Jmix documentation)

      • playwright

Your First Request

Describe the task in Jmix terms: entities, attributes, views, roles. A small first task looks like this:

Create a Customer entity with the name, email and phone attributes.
The name is required. Create list and detail views for Customer
and add the list view to the main menu.

For a larger task, ask the agent to write a plan first. Review the plan, then ask the agent to implement it.

Look at the agent’s changes in Studio:

If something is wrong, tell the agent what you see and ask it to fix the problem, or change the code yourself in Studio.

Jmix Agent Toolkit

The Jmix Agent Toolkit helps an AI agent follow Jmix patterns, architecture, and best practices. Its source code is available on GitHub.

The toolkit adds the following to your project:

  • Agent skills for Jmix features: entities, views, data access, and more. The skills are installed in .agents/skills and linked into .claude/skills.

  • A short block in AGENTS.md that points the agent to the Jmix skills. For Claude Code, the toolkit also adds a CLAUDE.md file that imports AGENTS.md.

  • Configuration of MCP servers:

    • jetbrains lets the agent use the code analysis and inspections of IntelliJ IDEA. To use it, enable the MCP server in IntelliJ IDEA: open Settings → Tools → MCP Server and select Enable MCP Server. Keep IntelliJ IDEA running with the project open while the agent works.

    • context7 provides the agent documentation and code examples of libraries, including Jmix, from their official sources.

    • jmix-docs lets the agent search the Jmix documentation, Java API and UI samples. Its Streamable HTTP endpoint is available at https://docs-mcp.jmix.io/mcp.

    • playwright lets the agent check the running application in a web browser.

Use the AI Agents Toolkit action in Studio or the CLI script to install the toolkit. Projects created with Jmix CLI include it by default.