README.mdā¢4.02 kB
# OneTech MCP Server
[](https://www.npmjs.com/package/@jordnlvr/onetech-mcp-server)
[](https://opensource.org/licenses/MIT)
**Extract and document Mendix Studio Pro modules via Model Context Protocol (MCP)**
OneTech MCP Server enables AI assistants like GitHub Copilot to interrogate local Mendix `.mpr` files and extract comprehensive module documentation including domain models, pages, microflows, and enumerations.
## š Quick Start
### Install Globally (Recommended)
```bash
npm install -g @jordnlvr/onetech-mcp-server
```
### Or Use with NPX (No Install)
```bash
npx @jordnlvr/onetech-mcp-server
```
### Configure in VS Code
Add to your VS Code `settings.json`:
```json
{
"github.copilot.chat.mcp.enabled": true,
"github.copilot.chat.mcp.servers": {
"onetech": {
"command": "npx",
"args": ["@jordnlvr/onetech-mcp-server"]
}
}
}
```
Or use global install:
```json
{
"github.copilot.chat.mcp.enabled": true,
"github.copilot.chat.mcp.servers": {
"onetech": {
"command": "onetech-mcp-server"
}
}
}
```
## š Usage
Once configured, use GitHub Copilot to extract module documentation:
```
You: "Extract the RequestHub module from D:\Projects\OneTech.mpr"
Copilot: [Uses onetech_extract_module tool]
ā
Successfully extracted 4 files from module 'RequestHub':
- DomainModel.json (57KB)
- Pages.json (42KB)
- Microflows.json (0KB)
- Enumerations.json (4KB)
```
## š ļø Available Tools
### `onetech_extract_module`
Extracts domain model, pages, microflows, and enumerations from a Mendix module using `mx.exe`.
**Parameters:**
- `mprPath` (required): Absolute path to the `.mpr` file
- `moduleName` (required): Name of the module to extract
- `outputPath` (required): Absolute path to output directory for JSON files
- `mxPath` (optional): Path to `mx.exe` (default: `D:\Program Files\Mendix\11.3.0.80734\modeler\mx.exe`)
**Returns:**
- JSON files containing complete module structure
- File sizes and extraction status
- Success/error messages
## š Requirements
- **Node.js**: >= 18.0.0
- **Mendix Studio Pro**: Version 11.3.0 or compatible
- **mx.exe**: Command-line tool (included with Studio Pro)
## š Privacy & Security
- **100% Local**: All processing happens on your machine
- **No Cloud**: Your `.mpr` files never leave your computer
- **No Tracking**: No telemetry, analytics, or data collection
- **Open Source**: Full transparency, audit the code yourself
## šÆ Use Cases
- **Documentation Generation**: Extract module structure for AI-powered docs
- **Code Review**: Analyze domain models and microflows
- **Migration Planning**: Understand module dependencies
- **Teaching**: Demonstrate Mendix architecture to students
- **Onboarding**: Help new developers understand existing apps
## š¦ What Gets Extracted
For each module, the tool generates 4 JSON files:
1. **DomainModel.json**: Entities, attributes, associations, validation rules
2. **Pages.json**: Page layouts, widgets, data sources
3. **Microflows.json**: Logic flows, actions, parameters
4. **Enumerations.json**: Enumeration types and values
## šļø Architecture
```
Your Machine
āāā VS Code + GitHub Copilot
āāā OneTech MCP Server (this package)
ā āāā Calls mx.exe with your .mpr file
āāā mx.exe (Mendix CLI)
āāā Your .mpr files (local, never uploaded)
```
## š¤ Contributing
Built by the OneTech Team for the Mendix developer community.
**Found a bug?** Open an issue on GitHub.
**Have a feature request?** Let us know!
## š License
MIT License - See LICENSE file for details
## š Links
- [Model Context Protocol](https://modelcontextprotocol.io/)
- [Mendix Documentation](https://docs.mendix.com/)
- [GitHub Repository](https://github.com/onetech/mcp-server)
---
**Version**: 0.1.0
**Status**: MVP Release
**First Mendix MCP Server** š