Skip to content

Commit 163b37c

Browse files
akoclaude
andcommitted
docs: add GitHub Copilot to supported AI tools across all docs
Copilot works out of the box via AGENTS.md with no dedicated --tool flag, making it the easiest path for organizations on Microsoft contracts. Added dedicated section in other-ai-tools.md and updated all tool lists across README, site docs, and migration guide. Co-Authored-By: Claude Opus 4.6 (1M context) <noreply@anthropic.com>
1 parent 65200c6 commit 163b37c

File tree

8 files changed

+23
-8
lines changed

8 files changed

+23
-8
lines changed

README.md

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -4,7 +4,7 @@
44
>
55
> **Do not edit a project with mxcli while it is open in Studio Pro.** Studio Pro maintains in-memory caches that cannot be updated externally. Close the project in Studio Pro first, run mxcli, then re-open the project.
66
7-
A command-line tool that enables AI coding assistants ([Claude Code](https://claude.ai/claude-code), OpenCode, Cursor, Continue.dev, Windsurf, Aider, and others) to read, understand, and modify Mendix application projects.
7+
A command-line tool that enables AI coding assistants ([Claude Code](https://claude.ai/claude-code), GitHub Copilot, OpenCode, Cursor, Continue.dev, Windsurf, Aider, and others) to read, understand, and modify Mendix application projects.
88

99
**[Read the documentation](https://mendixlabs.github.io/mxcli/)** | **[Try it in the Playground](https://codespaces.new/mendixlabs/mxcli-playground)** -- no install needed, runs in your browser
1010

@@ -13,7 +13,7 @@ A command-line tool that enables AI coding assistants ([Claude Code](https://cla
1313
Mendix projects are stored in binary `.mpr` files that AI agents can't read directly. `mxcli` bridges this gap by providing:
1414

1515
- **MDL (Mendix Definition Language)** - A SQL-like syntax for querying and modifying Mendix models
16-
- **Multi-tool support** - Works with Claude Code, Cursor, Continue.dev, Windsurf, Aider, and more
16+
- **Multi-tool support** - Works with Claude Code, GitHub Copilot, OpenCode, Cursor, Continue.dev, Windsurf, Aider, and more
1717
- **Full-text search** - Search across all strings, messages, and source definitions
1818
- **Code navigation** - Find callers, callees, references, and impact analysis
1919
- **Catalog queries** - SQL-based querying of project metadata

docs-site/src/migration/README.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1,6 +1,6 @@
11
# Migration Guide
22

3-
mxcli and MDL enable AI-assisted migration of existing applications to the Mendix platform. An AI coding agent (Claude Code, Cursor, Windsurf) investigates the source application, maps its elements to Mendix concepts, generates MDL scripts, and validates the result -- all from the command line.
3+
mxcli and MDL enable AI-assisted migration of existing applications to the Mendix platform. An AI coding agent (Claude Code, GitHub Copilot, OpenCode, Cursor, Windsurf) investigates the source application, maps its elements to Mendix concepts, generates MDL scripts, and validates the result -- all from the command line.
44

55
This part covers the five-phase migration workflow and the skills that support each phase.
66

docs-site/src/preface/vision.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -4,7 +4,7 @@ mxcli and MDL exist to make Mendix development accessible to coding agents, auto
44

55
## Coding Agents First
66

7-
The primary audience for mxcli is not a human typing commands -- it is a coding agent (Claude Code, Cursor, Windsurf, or similar) that reads, reasons about, and modifies Mendix projects autonomously. Everything in mxcli is designed with this in mind:
7+
The primary audience for mxcli is not a human typing commands -- it is a coding agent (Claude Code, GitHub Copilot, OpenCode, Cursor, Windsurf, or similar) that reads, reasons about, and modifies Mendix projects autonomously. Everything in mxcli is designed with this in mind:
88

99
- **MDL as machine-readable output.** Every `DESCRIBE` command produces valid MDL that can be fed back as input. Agents can read a microflow, modify it, and write it back without lossy format conversions.
1010
- **Skills and context files.** `mxcli init` generates structured skill files that teach agents MDL syntax, common patterns, and project conventions -- reducing hallucination and retry loops.

docs-site/src/preface/what-is-mxcli.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -28,7 +28,7 @@ A developer or AI agent writes MDL statements. mxcli parses and validates them,
2828
- **Catalog queries** -- SQL-based querying of project metadata (entity counts, microflow complexity, widget usage, cross-references).
2929
- **Linting and reports** -- 40+ built-in lint rules with SARIF output for CI; scored best-practices reports.
3030
- **Testing** -- test microflows using MDL syntax with javadoc-style annotations.
31-
- **AI assistant integration** -- works with Claude Code, Cursor, Continue.dev, Windsurf, and Aider. `mxcli init` sets up project configuration, skills, and a Dev Container for sandboxed AI development.
31+
- **AI assistant integration** -- works with Claude Code, GitHub Copilot, OpenCode, Cursor, Continue.dev, Windsurf, and Aider. `mxcli init` sets up project configuration, skills, and a Dev Container for sandboxed AI development.
3232
- **VS Code extension** -- syntax highlighting, diagnostics, code completion, hover, go-to-definition, and context menu commands for `.mdl` files.
3333
- **External SQL** -- connect to PostgreSQL, Oracle, or SQL Server; query external databases; import data into a running Mendix application.
3434

docs-site/src/tutorial/ai-assistants.md

Lines changed: 2 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -32,6 +32,7 @@ mxcli supports six AI coding assistants out of the box, plus a universal format
3232
| **Continue.dev** | `--tool continue` | `.continue/config.json` | Custom commands and slash commands |
3333
| **Windsurf** | `--tool windsurf` | `.windsurfrules` | Codeium's AI with MDL rules |
3434
| **Aider** | `--tool aider` | `.aider.conf.yml` | Terminal-based AI pair programming |
35+
| **GitHub Copilot** | (universal) | `AGENTS.md`, `.ai-context/` | Reads AGENTS.md and project context automatically |
3536
| **Universal** | (always created) | `AGENTS.md`, `.ai-context/` | Works with all tools |
3637

3738
```bash
@@ -45,7 +46,7 @@ The workflow is the same regardless of which AI tool you use:
4546

4647
1. **Initialize** -- `mxcli init` creates config files, skills, and a dev container
4748
2. **Open in dev container** -- sandboxes the AI so it only accesses your project
48-
3. **Start the AI assistant** -- Claude Code, Cursor, Continue.dev, etc.
49+
3. **Start the AI assistant** -- Claude Code, GitHub Copilot, Cursor, etc.
4950
4. **Ask for changes in natural language** -- "Create a Customer entity with name and email"
5051
5. **The AI explores** -- it runs SHOW, DESCRIBE, and SEARCH commands via mxcli
5152
6. **The AI writes MDL** -- guided by the skill files installed in your project

docs-site/src/tutorial/claude-code.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -214,4 +214,4 @@ Claude validates the script, executes it, and reports back. You can then open th
214214

215215
## Next steps
216216

217-
If you use other AI tools alongside Claude Code, see [Cursor / Continue.dev / Windsurf](other-ai-tools.md). To understand how skills work in detail, see [Skills and CLAUDE.md](skills.md).
217+
If you use other AI tools alongside Claude Code, see [Other AI tools](other-ai-tools.md) (GitHub Copilot, OpenCode, Cursor, Continue.dev, Windsurf). To understand how skills work in detail, see [Skills and CLAUDE.md](skills.md).

docs-site/src/tutorial/installation.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -12,7 +12,7 @@ The Codespace comes with mxcli, a JDK, Docker-in-Docker, Claude Code, and a samp
1212

1313
- **5 example scripts** -- explore, create entities, microflows, pages, and security
1414
- **Step-by-step tutorials** -- from first steps through linting and testing
15-
- **AI tool configs** -- pre-configured for Claude Code, Cursor, Windsurf, Continue.dev, and Aider
15+
- **AI tool configs** -- pre-configured for Claude Code, GitHub Copilot, OpenCode, Cursor, Windsurf, Continue.dev, and Aider
1616

1717
Once the Codespace is running:
1818

docs-site/src/tutorial/other-ai-tools.md

Lines changed: 14 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -64,6 +64,7 @@ On top of the universal files, each tool gets its own configuration:
6464
|------|-------------|----------|
6565
| **Claude Code** | `.claude/`, `CLAUDE.md` | Settings, skills, commands, lint rules, project context |
6666
| **OpenCode** | `.opencode/`, `opencode.json` | Skills, commands, lint rules, project context |
67+
| **GitHub Copilot** | `AGENTS.md` | Reads universal context automatically via VS Code |
6768
| **Cursor** | `.cursorrules` | Compact MDL reference and mxcli command guide |
6869
| **Continue.dev** | `.continue/config.json` | Custom commands and slash commands |
6970
| **Windsurf** | `.windsurfrules` | MDL rules for Codeium's AI |
@@ -79,6 +80,19 @@ OpenCode receives full integration on par with Claude Code: dedicated skills in
7980
mxcli init --tool opencode /path/to/project
8081
```
8182

83+
### GitHub Copilot
84+
85+
GitHub Copilot works with mxcli out of the box via the universal `AGENTS.md` file — no dedicated `--tool` flag is needed. Copilot's agent mode in VS Code automatically reads markdown files in the project root, so after running `mxcli init`, Copilot has access to the full MDL reference and skill files.
86+
87+
```bash
88+
# Any mxcli init creates AGENTS.md, which Copilot reads automatically
89+
mxcli init /path/to/project
90+
```
91+
92+
For many organizations, Copilot is the default AI assistant as part of their Microsoft/GitHub enterprise agreement. mxcli supports this by ensuring the universal files (`AGENTS.md`, `.ai-context/skills/`) provide enough context for Copilot to work effectively with MDL.
93+
94+
To use: open the project in VS Code with the GitHub Copilot extension, open Copilot Chat (Ctrl+Shift+I), and ask for Mendix changes. Copilot will reference `AGENTS.md` and the skill files for MDL syntax guidance.
95+
8296
### Cursor
8397

8498
Cursor reads its instructions from `.cursorrules` in the project root. The file mxcli generates contains a compact MDL syntax reference and a list of mxcli commands the AI can use. Cursor's Composer and Chat features will reference this file automatically.

0 commit comments

Comments
 (0)