{"id":49854391,"url":"https://github.com/jmix-framework/jmix-agent-guidelines","last_synced_at":"2026-05-14T19:08:41.325Z","repository":{"id":337096794,"uuid":"1151464486","full_name":"jmix-framework/jmix-agent-guidelines","owner":"jmix-framework","description":"A collection of guidelines and agent skills designed to help AI coding agents develop applications using the Jmix framework effectively","archived":false,"fork":false,"pushed_at":"2026-04-18T06:42:38.000Z","size":56,"stargazers_count":7,"open_issues_count":3,"forks_count":3,"subscribers_count":0,"default_branch":"main","last_synced_at":"2026-04-18T08:34:35.995Z","etag":null,"topics":[],"latest_commit_sha":null,"homepage":"https://www.jmix.io","language":null,"has_issues":true,"has_wiki":null,"has_pages":null,"mirror_url":null,"source_name":null,"license":null,"status":null,"scm":"git","pull_requests_enabled":true,"icon_url":"https://github.com/jmix-framework.png","metadata":{"files":{"readme":"README.md","changelog":null,"contributing":null,"funding":null,"license":null,"code_of_conduct":null,"threat_model":null,"audit":null,"citation":null,"codeowners":null,"security":null,"support":null,"governance":null,"roadmap":null,"authors":null,"dei":null,"publiccode":null,"codemeta":null,"zenodo":null,"notice":null,"maintainers":null,"copyright":null,"agents":null,"dco":null,"cla":null}},"created_at":"2026-02-06T13:57:23.000Z","updated_at":"2026-04-18T06:42:42.000Z","dependencies_parsed_at":null,"dependency_job_id":null,"html_url":"https://github.com/jmix-framework/jmix-agent-guidelines","commit_stats":null,"previous_names":["jmix-framework/jmix-agent-guidelines"],"tags_count":0,"template":false,"template_full_name":null,"purl":"pkg:github/jmix-framework/jmix-agent-guidelines","repository_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/jmix-framework%2Fjmix-agent-guidelines","tags_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/jmix-framework%2Fjmix-agent-guidelines/tags","releases_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/jmix-framework%2Fjmix-agent-guidelines/releases","manifests_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/jmix-framework%2Fjmix-agent-guidelines/manifests","owner_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners/jmix-framework","download_url":"https://codeload.github.com/jmix-framework/jmix-agent-guidelines/tar.gz/refs/heads/main","sbom_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/jmix-framework%2Fjmix-agent-guidelines/sbom","scorecard":null,"host":{"name":"GitHub","url":"https://github.com","kind":"github","repositories_count":286080680,"owners_count":33039316,"icon_url":"https://github.com/github.png","version":null,"created_at":"2022-05-30T11:31:42.601Z","updated_at":"2026-05-13T13:14:54.681Z","status":"online","status_checked_at":"2026-05-14T02:00:06.663Z","response_time":57,"last_error":null,"robots_txt_status":"success","robots_txt_updated_at":"2025-07-24T06:49:26.215Z","robots_txt_url":"https://github.com/robots.txt","online":true,"can_crawl_api":true,"host_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub","repositories_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories","repository_names_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repository_names","owners_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners"}},"keywords":[],"created_at":"2026-05-14T19:08:40.776Z","updated_at":"2026-05-14T19:08:41.320Z","avatar_url":"https://github.com/jmix-framework.png","language":null,"funding_links":[],"categories":[],"sub_categories":[],"readme":"# Jmix AI Agent Guidelines\n\nThis repository provides a collection of guidelines and \"agent skills\" designed to help AI coding agents develop applications using the [Jmix framework](https://www.jmix.io/) effectively.\n\nThe AI agent will use these resources to understand Jmix-specific patterns, mandatory rules, and best practices.\n\n## Repository Structure\n\n- `v2/` contains the guidelines for Jmix 2.x.\n  - `AGENTS.md`: General coding guidelines, architecture overview, and development workflow for Jmix projects.\n  - `skills/`: A collection of folders, each containing:\n      - `SKILL.md`: Detailed instructions and rules for the agent regarding a specific Jmix feature.\n      - Optional subdirectories with examples or other materials.\n\n## How to Use\n\nTo enable these guidelines for your AI agent, follow the steps below. \n\nTake the files from the `v2/` directory if you are using Jmix 2.x.\n\n### 1. Project Guidelines\n\nCopy the `AGENTS.md` file from this repository to the root of your Jmix application project. Depending on the agent you are using, you may need to rename it or place it in a specific folder:\n\n- [Claude Code](https://code.claude.com/docs): Copy to the project root and rename to `CLAUDE.md`.\n- [Codex](https://developers.openai.com/codex/cli): Copy to the project root and keep as `AGENTS.md`.\n- [OpenCode](https://opencode.ai/docs): Copy to the project root and keep as `AGENTS.md`.\n- [Junie](https://www.jetbrains.com/junie): Copy to the `.junie` project subdirectory and rename to `guidelines.md`.\n\n### 2. Agent Skills\n\nThe `skills/` directory contains specialized knowledge for developing various Jmix features (entities, UI views, data access, etc.). These should be made available to the agent globally.\n\nCopy or symlink the content of the `skills/` subdirectory to the folder recognized by your agent in your home directory:\n\n| Agent       | Skills Folder Path           |\n|:------------|:-----------------------------|\n| Claude Code | `~/.claude/skills/`          |\n| Codex       | `~/.codex/skills/`           |\n| OpenCode    | `~/.config/opencode/skills/` |\n| Junie       | `~/.junie/skills/`           |\n\n#### Example\n\nUsing symlink for Claude Code:\n```bash\nmkdir -p ~/.claude/skills\nln -s /path/to/jmix-agent-guidelines/v2/skills/* ~/.claude/skills/\n```\n\n#### Agent Conventions Summary\n\n| Agent       | Project Guidelines     | Home Directory Base   |\n|:------------|:-----------------------|:----------------------|\n| Claude Code | `CLAUDE.md`            | `~/.claude/`          |\n| Codex       | `AGENTS.md`            | `~/.codex/`           |\n| OpenCode    | `AGENTS.md`            | `~/.config/opencode/` |\n| Junie       | `.junie/guidelines.md` | `~/.junie/`           |\n\n### 3. MCP Servers\n\nThe following two MCP servers help AI agents to build Jmix apps:\n\n- JetBrains (**highly recommended**): lets an external agent talk to a running IntelliJ IDEA to leverage code analysis and inspections.\n\n- Context7 (optional): gives the agent docs and code examples from official sources.\n\nTo run the JetBrains MCP server in IntelliJ IDEA, go to **Settings → Tools → MCP Server** and select **Enable MCP Server ✓**. When working with  a project, keep it open in the IDE.\n\nBelow are practical setup snippets per agent.\n\n#### Claude Code\n\n- JetBrains MCP:\n    ```bash\n    claude mcp add --transport sse jetbrains --scope user http://localhost:64342/sse\n    ```\n\n- Context7 MCP:\n    ```bash\n    claude mcp add context7 --scope user -- npx -y @upstash/context7-mcp --api-key YOUR_API_KEY\n    ```\n\n#### Codex\n\n- JetBrains MCP:\n\n  If you have IntelliJ IDEA 2026.1 or above, execute the following command to use Streamable HTTP connection:\n\n    ```bash\n    codex mcp add jetbrains --url http://localhost:64342/stream\n    ```\n\n  For an older IntelliJ IDEA version, follow the steps below to use STDIO connection.\n\n  Open **Settings → Tools → MCP Server** and click **Copy Stdio Config** in **Manual Client Configuration** section. Paste the JSON into a text editor. You will see something like this:\n\n    ```json\n    {\n      \"type\": \"stdio\",\n      \"env\": {\n        \"IJ_MCP_SERVER_PORT\": \"64342\"\n      },\n      \"command\": \"\u003cyour path to java\u003e\",\n      \"args\": [\n        \"-classpath\",\n        \"\u003cyour very long classpath\u003e\",\n        \"com.intellij.mcpserver.stdio.McpStdioRunnerKt\"\n      ]\n    }\n    ```\n\n  Open the terminal and run the following command using the values from the JSON:\n\n    ```bash\n    codex mcp add jetbrains --env IJ_MCP_SERVER_PORT=64342 -- \"\u003cyour path to java\u003e\" -classpath \"\u003cyour very long classpath\u003e\" \"com.intellij.mcpserver.stdio.McpStdioRunnerKt\"\n    ```\n\n- Context7 MCP:\n    ```bash\n    codex mcp add context7 -- npx -y @upstash/context7-mcp --api-key YOUR_API_KEY\n    ```\n\n#### OpenCode\n\nAdd to your `~/.config/opencode/opencode.json`:\n\n```json\n{\n  \"mcp\": {\n    \"jetbrains\": {\n      \"type\": \"remote\",\n      \"url\": \"http://localhost:64342/sse\",\n      \"enabled\": true\n    },\n    \"context7\": {\n      \"type\": \"local\",\n      \"command\": [\"npx\", \"-y\", \"@upstash/context7-mcp\", \"--api-key\", \"YOUR_API_KEY\"],\n      \"enabled\": true\n    }\n  }\n}\n```\n\n#### Junie\n\n- JetBrains MCP: not required. Junie runs inside the IntelliJ and already has native access to the IDE features.\n\n- Context7 MCP: \n  \n    Open **Settings → Tools → Junie → MCP Settings** and click **Add**. Paste the following JSON into the text field:\n\n    ```json\n    {\n      \"mcpServers\": {\n        \"context7\": {\n          \"command\": \"npx\",\n          \"args\": [\"-y\", \"@upstash/context7-mcp\", \"--api-key\", \"YOUR_API_KEY\"]\n        }\n      }\n    }  \n    ```\n  \n### 4. Playwright Tests\n\n[Playwright](https://playwright.dev) integration provides AI agents with the ability to perform UI verification on a running application. This allows the agent to test navigation and complex UI behaviors directly in the browser.\n\nTo enable Playwright support:\n\n- Install Playwright CLI globally:\n    ```bash\n    npm i -g @playwright/cli@latest\n    ```\n\n- Install Playwright skills:\n    ```bash\n    playwright-cli install --skills\n    ```\n    The command above creates Playwrite skills in the `.claude/skills` directory. If you are using a different agent, copy or symlink them to the directory supported by your agent (see [Agent Skills](#2-agent-skills) section).\n\nOnce set up, you can give the agent instructions like:\n\n\u003e Run the app and use playwright skill to login and test all created views\n","project_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fjmix-framework%2Fjmix-agent-guidelines","html_url":"https://awesome.ecosyste.ms/projects/github.com%2Fjmix-framework%2Fjmix-agent-guidelines","lists_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fjmix-framework%2Fjmix-agent-guidelines/lists"}