
Connects Claude and other MCP clients directly to the GeneXus 18 SDK so you can read, edit, and refactor objects in a live Knowledge Base without leaving your AI chat. Point it at your KB folder and GeneXus install path, then ask the agent to list transactions by attribute, add validation rules, rename variables in procedures, or modify WorkWithPlus patterns including layout and theming. Windows only, requires GeneXus 18 and Node.js 18+. Ships with an installer that auto-configures Claude Desktop, Cursor, and other detected clients, plus a corporate install script that extracts binaries to a stable path for environments with ASR policies. Useful if you spend time in GeneXus and want to prototype or audit KB changes conversationally before opening the IDE.
¿Hablás español? → Guía de inicio en español Fala português? → Guia de início em português Stuck? → Troubleshooting guide
GeneXus MCP Server lets AI agents — Claude Desktop, Claude Code, Cursor, Antigravity, and any MCP-compatible client — read, edit, analyze, and refactor objects inside a Knowledge Base supported by the selected native SDK or legacy compatibility driver. Native SDK paths work with the real GeneXus SDK and legacy paths use explicit reflection/COM adapters; neither path relies on a parsed copy of the KB.
In practice: you point the MCP at your KB, then ask your AI assistant things like "list all transactions with attribute CustomerId", "add a rule to the Order transaction that validates the total", or "refactor this procedure to use the new SDT" — and it does it.
The same MCP distribution supports the official native SDK majors listed in the
generated compatibility document. It also includes basic, best-effort
compatibility for the legacy versions listed there through separate drivers;
that path is not equivalent to full native-SDK support. A process can route
each declared KB to its own SDK/driver; --gx remains the convenient global
default for a single-major configuration. The commands below are examples of
switching the existing configuration:
npx genexus-mcp@latest init --kb "C:\KBs\KBTeste17" --gx "C:\Program Files (x86)\GeneXus\GeneXus17Trial"
# To switch this MCP configuration to GX18:
npx genexus-mcp@latest init --kb "C:\KBs\MyGX18KB" --gx "C:\Program Files (x86)\GeneXus\GeneXus18"
After switching the SDK or KB, fully restart the AI client so it reloads the MCP process and its tool schemas. If GX17 and GX18 must run simultaneously, use separate MCP configurations and ports.
Classic GX8/GX9 KBs can be opened without changing the global GX18 default by declaring their driver and installation per KB (the Gateway accepts both the list and object catalog shapes):
{
"Environment": {
"KBs": {
"SECT80": {
"Path": "D:\\GX80\\SECT",
"Driver": "com-gxpublic",
"InstallationPath": "C:\\Program Files (x86)\\ARTech\\GeneXus\\gxw80",
"Major": "8"
}
}
}
}
The equivalent one-shot request is genexus_kb action=open with path,
alias, driver: "com-gxpublic", installationPath, and major: "8".
GX8 uses the registered 32-bit GXPublic provider; the documented .4 ProgID
and the installed GXPubGXX.GXPublic(.5) compatibility registration are
recognized. Classic DAT KB roots are identified from their legacy markers
(DATA001, GXSPC001, kbdata, ATTRIBUT.DAT, or ATT.XPW).
init also reads the KB .gxw major and the selected GeneXus.exe metadata.
It aborts before writing config.json when the majors conflict or an automatic
selection cannot be verified. When several installs share the KB major, the
automatic selection prefers the one whose update matches the .gxw version
(e.g. U7 for an 18.0.7.x KB) over the newest one. genexus-mcp doctor exposes the same result as
the kb_sdk_compatibility check. For a disposable fixture, the
live-KB harness includes a catalog-driven matrix
that checks every supported major against one published artifact.
The Gateway reports the detected SDK through genexus_whoami:
geneXus.supportedMajors: explicitly validated native SDK majors from the version cataloggeneXus.legacyMajors: catalogued legacy majors handled by their compatibility driversgeneXus.sdkCompatibility.supportLevel: native-sdk or basic-legacy for the detected installationgeneXus.matchedMajor: the major detected for the configured installationgeneXus.versionMatches: whether the detected installation is in that cataloggeneXus.supportedMajor: retained as the legacy single-major alias for the catalog primaryThe Worker isolates version-sensitive SDK members behind compatibility adapters.
For example, Design System helper methods that differ between SDK majors are
replaced field-by-field by parsing the native Tokens and Styles parts when
needed. Existing tool names, arguments, and MCP client configuration formats do
not change.
Supported SDK majors: GeneXus 16, GeneXus 17, GeneXus 18 (native SDK).
Basic legacy compatibility: GeneXus Evolution 3, GeneXus Evolution 2, GeneXus Evolution 1, GeneXus 15, GeneXus 9.0, GeneXus 8.0 via com-gxpublic and dotnet-reflection (not the native SDK build).
Primary SDK: GeneXus 18.
Source of truth: config/gx-versions.json.
To add another native-SDK major in the future, add it to the explicit
supportedMajors catalog only after compiling the Worker with that SDK and
passing the focused tests plus a live KB smoke. This prevents the server from
claiming native-SDK compatibility based only on a version string.
Every legacy version currently declared in legacyMajors uses a best-effort
driver rather than the native SDK build:
dotnet-reflection), dynamically adapting to missing types or structural differences (such as module-less KBs without QualifiedName).com-gxpublic), detected from gxw32.exe/gx.exe/gxdl32.dll and classic .gxi Knowledge Bases. GXPublic is a metadata-oriented OLE DB surface; this path is intentionally limited to basic metadata/core operations and does not claim native-SDK source/edit parity.genexus_api, genexus_gam, or genexus_module) return structured UNSUPPORTED_IN_GENEXUS_VERSION errors indicating the required minimum version rather than failing ungracefully.This legacy path is intended for basic core operations where implemented; it does not claim the same feature parity as the native SDK contract for GeneXus 16, 17, and 18.
The Gateway and the GeneXus SDK Worker have different responsibilities. By
default, Server.WorkerSharingMode is "isolated": each Gateway owns its own
Worker process. Keep that mode when an agent intentionally needs multiple
independent Workers.
When two or more independent MCP clients need to work on the same physical KB,
set WorkerSharingMode to "shared-host" in a stdio-isolated configuration:
{
"ConfigSchemaVersion": 2,
"GatewayMode": "stdio-isolated",
"GeneXus": {
"InstallationPath": "C:\\Program Files (x86)\\GeneXus\\GeneXus18",
"WorkerExecutable": "C:\\path\\to\\GxMcp.Worker.exe"
},
"Server": {
"HttpPort": 0,
"McpStdio": true,
"WorkerSharingMode": "shared-host"
},
"Environment": {
"ResolutionPolicy": "strict",
"KBs": [
{ "alias": "main", "path": "C:\\KBs\\YourKB" }
]
}
}
shared-host shares only the per-KB broker-owned SDK Worker through bounded
local named-pipe attachments. The Gateways remain independent: MCP sessions,
authorization, KB selection, caches, request tracking, cancellation, progress,
notifications, and generated artifacts do not cross the process boundary.
Sharing is accepted only when the physical KB, Worker executable, GeneXus
installation, driver, and target major are compatible; a mismatch fails closed
instead of attaching to the wrong SDK process.
Writes carry a Gateway-local owner into the Worker. The same object/part cannot be written concurrently by two attached clients, while writes to distinct objects may proceed independently through the shared SDK boundary. The Worker itself remains a single STA process, so calls that reach the same SDK are still serialized as required by GeneXus.
For a healthy shared attachment, genexus_whoami and genexus_doctor report the
mode, identity key, pipe, host/Worker PIDs, generation, attachment ID, connection
state, and the latest startup/failure diagnostic. When something fails, inspect
worker.diagnostics and workerHealth before restarting or deleting local
state; these fields distinguish configuration/identity, mutex or registry,
pipe/handshake, startup, child exit/respawn, TTL, and frame failures.
See Worker ownership for the lifecycle contract and the shared-Worker benchmark for the measured two-client smoke and backpressure results.
A quick map of what the agent can do against your real KB through the 50 tools (details in Tool Surface):
| Area | What the agent can do |
|---|---|
| 🔎 Explore | Search & list objects, read any part (source, rules, events, structure, docs, pattern XML), inspect metadata & callers, regex-search source, view the navigation report |
| ✏️ Edit code | Edit any object part (full/patch/ops modes), variables CRUD, format, create & delete objects, scaffold a Procedure from a curl command, edit + rebuild callers in one shot |
| 🗄️ Author the data model | Transaction structure (DSL), unique/non-unique indexes (create & drop), attribute formulas & subtypes, level Description/Image attributes, Domain enum values, folders & modules, table↔transaction relations & redundant-attribute detection |
| 🧩 Author other objects | External Object methods & properties, Menu options, REST API objects, WorkWithPlus / WorkWith patterns, typed .NET generator references |
| 🎨 UI & WorkWithPlus | Full read/write of pattern XML (controls, actions, grids, orders, groups), theme classes & styling, native WebForm/layout edits, control catalog & design-system tokens/classes/images, headless-browser verification |
| 🔬 Analyze | Impact/dependency analysis, complexity & code metrics, naming, explain-what-this-does, KB activity/freshness, reorg/DDL impact preview, native security scan, schema-drift check |
| 🛠️ Build, test & deploy | Build (full or fast compile_check), validate, reorg, index, run native GXtest tests, deploy the application (targets + deploy) |
| 🔀 Refactor & compare | Rename across the KB, extract procedure, compare & merge objects (IDE parity) |
| 🌿 Versioning, transfer & teams | KB model versions/branches, real XPZ export/import (dependency-aware), GXserver (Team Development) sync + CI pipelines, git-style history, multi-KB parallel work |
| 🔐 Security | GAM / integrated-security provisioning, KB security audit + native Security Scanner |
Native SDK support works through the native GeneXus SDK — the same code paths the IDE uses — so edits are real and validated, not text hacks on KB files. Legacy support uses the reflection or COM driver listed in the catalog and degrades unsupported modern tools explicitly.
Before you start, make sure you have:
docs/generated/supported-versions.md; pass another install path explicitly when needed)node --version in a terminal; install from nodejs.org if missingYou do not need to clone this repo or install anything globally — npx handles it.
Never used a terminal before? Press Win+R, type powershell, hit Enter. That's your terminal.
Before running the installer, note these down:
GeneXus.exe lives. Usually C:\Program Files (x86)\GeneXus\GeneXus18..gx file and subfolders like Model/, WebSpa/).Not sure where your KB lives? Open it in GeneXus and check the title bar, or look in File → Recent.
Open a terminal and run, replacing the paths with your KB folder and your GeneXus install:
npx genexus-mcp@latest init --kb "C:\KBs\YourKB" --gx "C:\Program Files (x86)\GeneXus\GeneXus18"
Prefer the wizard? Run
npx genexus-mcp@latest init --interactiveand answer the prompts.
What you'll see (takes ~30 seconds first time, faster on re-runs):
npx downloads the package.🎉 You are all set!.On Windows, Antigravity is registered with the gateway executable bundled in the
current npm package when that artifact is available, so it skips the npx bootstrap
chain on every MCP handshake. That path follows the package in the npx cache; after
an upgrade, run npx genexus-mcp@latest clients add --clients antigravity again if
genexus-mcp clients reports a stale launcher. Other clients keep the npx genexus-mcp@latest
launcher unless you use the fixed-path installer below.
Step 1 auto-registers every supported client it detects, including Claude Desktop, Claude Code, Cursor, Antigravity, Gemini CLI, OpenCode, Codex CLI, and VS Code. If yours wasn't detected, copy the JSON snippet from Step 1 into your client's MCP config manually. See the client setup guide if unsure where that file lives.
This part trips most people: fully close your AI client and reopen it. Not just the window — the whole process.
opencode.json / opencode.jsonc.Then paste this prompt:
"Using the GeneXus MCP, list the first 5 objects in my KB and show name + type."
What should happen:
genexus_list_objects tool (some UIs show "calling tool…").If you get a list back — you're done. Skip to What can I ask the AI? for ideas.
If the AI says it doesn't have a GeneXus tool, or nothing happens, go to Troubleshooting — most issues are covered there.
If you'd rather not run anything in the terminal yourself, paste this into your AI chat:
Please configure the GeneXus MCP server. Run
npx genexus-mcp@latest init --kb "<MY_KB_PATH>" --gx "<MY_GENEXUS_PATH>"in the terminal. If I haven't told you my GeneXus path and KB path yet, ask me first. Once it succeeds, read the JSON block it printed and add it to my MCP client config. Tell me when I should restart the client to start using GeneXus tools.
Replace the placeholders or let the AI ask you for them.
If your machine has Microsoft Defender ASR, SmartScreen, or another endpoint policy blocking unsigned binaries, the default npx flow is painful — npx caches the package under %LOCALAPPDATA%\npm-cache\_npx\<hash>\..., and the <hash> changes per version, so IT can't whitelist a stable path without a wildcard over the whole npm cache (which is too broad).
Use the corporate installer instead. It extracts the binaries to a stable directory and registers the AI clients to launch the gateway directly from there — npx is never on the runtime path.
# One-liner — installs latest release, registers AI clients
iex (irm https://raw.githubusercontent.com/lennix1337/Genexus18MCP/main/scripts/install.ps1)
# With explicit KB and GeneXus paths
$s = irm https://raw.githubusercontent.com/lennix1337/Genexus18MCP/main/scripts/install.ps1
& ([scriptblock]::Create($s)) -Kb "C:\KBs\MyKB" -Gx "C:\Program Files (x86)\GeneXus\GeneXus18"
Install location:
C:\Tools\GenexusMCP\%LOCALAPPDATA%\Programs\GenexusMCP\Paths to give to IT for the ASR / Defender exclusion list:
<InstallDir>\GxMcp.Gateway.exe
<InstallDir>\worker\GxMcp.Worker.exe
Re-run the same one-liner later to upgrade — it detects the installed version (version.txt in the install dir) and downloads only if a newer release is available. Use -Force to reinstall the same version, -Version v2.3.0 to pin a specific tag, -NoClient to skip AI client registration. Node.js 22+ must be installed for client registration; without it the script still extracts the binaries but you'll need to edit the client config (claude_desktop_config.json etc.) manually.
Once installed, here's what unlocks. Try these as your first prompts:
Exploration
Editing
Data model authoring (no IDE round-trip)
WorkWithPlus pattern editing (full structural + theming control)
Analysis
genexus_analyze mode=explain is a compatibility-only envelope and returns NotImplemented; use mode=summary, mode=context, or genexus_read for supported analysis and source.Build & lifecycle
The agent picks the right tool from the 50 tools the MCP exposes (read, edit, refactor, analyze, build, data-model authoring, layout automation, DB/DDL, versioning, security, SQL preview, etc.). The full tool list is in Tool Surface below.
Auto-detected and auto-configured by the installer:
| Client | Auto-config | Notes |
|---|---|---|
| Claude Desktop | ✅ | Restart required after install |
| Claude Code (CLI) | ✅ | Reload session |
| Cursor | ✅ | Restart required |
| Antigravity | ✅ | Direct packaged gateway; restart required; detected even before its MCP config exists |
| Gemini CLI | ✅ | — |
| OpenCode (CLI) | ✅ | Reads both direct and nested MCP layouts; restart required |
| Codex CLI | ✅ | Writes ~/.codex/config.toml |
| VS Code / VS Code Insiders | ✅ | Native MCP (User/mcp.json); restart required |
| OpenCode Desktop | ✅ | Shares opencode.jsonc with OpenCode CLI; restart required |
| Any MCP client | Manual | Use the JSON snippet printed by init |
Run npx genexus-mcp clients at any time to see which agents are installed, which have genexus registered, and whether any point at a stale gateway exe. To (re)register specific ones: npx genexus-mcp clients add --clients antigravity,vscode.
OpenCode Desktop shares its MCP configuration file (opencode.jsonc or opencode.json)
with OpenCode CLI. Running genexus-mcp init --write-clients or genexus-mcp clients add --clients opencode-desktop
automatically registers genexus18mcp in the shared config. After registration,
fully restart OpenCode Desktop so it reloads its MCP configuration.
First stop for any "the agent doesn't see GeneXus" problem: npx genexus-mcp clients (is it registered? does it point at a gateway exe that still exists?) and npx genexus-mcp doctor --mcp-smoke.
Most install issues fall into a handful of buckets — see TROUBLESHOOTING.md for fixes:
%LOCALAPPDATA%\GenexusMCP\exit status 1 / 0xffffffff with no useful stderrWhen a stdio launcher fails before the client can retain stderr, the wrapper writes
the last failure to %LOCALAPPDATA%\GenexusMCP\logs\last-stdio-error.txt. It contains
the UTC timestamp, exit code, and bounded stderr tail. genexus-mcp doctor reports the
same path when a previous failure is present. Read it before changing the install or
using a global npm install; if the Antigravity launcher is stale, re-register it with
npx genexus-mcp@latest clients add --clients antigravity.
If shared-host does not attach or a Worker is restarted, run
genexus_whoami and genexus_doctor from the affected client and preserve the
structured worker.diagnostics/workerHealth block. The useful evidence is the
mode, identity, host/Worker PID, generation, attachment state, connection error,
and failure diagnostic — not only the final no_worker or startup_failed
summary. Do not remove a shared-worker registry file while a matching host is
still running; the broker owns that lifecycle and stale records are recovered
after PID/start-time validation.
Still stuck? Open an issue with the output of npx genexus-mcp doctor --mcp-smoke and the bounded diagnostic fields above. Redact credentials, tokens, connection strings, and other sensitive values.
The worker exposes 50 tools to the MCP router, grouped by capability below. Most are umbrellas with an action (e.g. genexus_db action=sql_ddl); the detailed schemas live in src/GxMcp.Gateway/tool_definitions.json.
Orientation & health
genexus_whoami — KB context, version, worker/index/database health, self-update check, next-step hintsgenexus_doctor — connection + install + cache health checkgenexus_recipe — named playbooks / self-extending macrosgenexus_telemetry — observability (metrics, latency, errors)Search & discovery
genexus_query — object search (prefixes name:, type:, usedby:, parent:, …)genexus_list_objects — paginated object listing with aggregatesgenexus_read — read any part of an object (source, structure, rules, events, docs, pattern XML, …)genexus_inspect — one-shot object snapshot (metadata, variables, structure, signature, callers)genexus_search_source — regex/semantic search across Procedure/DataProvider/WebPanel/Transaction sourcegenexus_navigation — the IDE "View Navigation" reportFor a GeneXus 18 U16 Data Selector, genexus_read type=DataSelector also accepts
parameters, conditions, orders, definedBy, baseTransaction,
baseTable, and structure. It preserves SDK order and complete expressions,
returns a versionToken, and performs no lifecycle operation. The public U16
SDK does not expose a projected-attribute collection or resolved joins for this
object type, so projection and joins are returned in unsupportedParts with
the technical reason instead of misleading empty arrays. Base objects and
declared indexes are reported only when they can be resolved without Specify.
structure.expression is identified as a semanticProjection: it combines the
typed public SDK elements and never exposes the internal collection type names
produced by DataSelectorStructurePart.ToString() on U16.
To change a Data Selector's conditions use genexus_edit type=DataSelector part=Conditions mode=full with one condition per line (genexus_read parts=["conditions"] also returns
that text as source). The list is replaced as a whole, parameters/orders/Defined By are
left untouched, and the saved conditions are re-read and verified. A Data Selector whose
conditions sit inside a nested AND/OR group is refused with
DataSelectorConditionsNestedGroupsUnsupported and nothing is saved: the one-per-line form
carries no grouping, so replacing the list would silently flatten it. Flatten those levels
in GeneXus first.
Editing
genexus_edit — edit any object part; modes full / patch / opsgenexus_edit_and_build — edit + optional specification + rebuild callers in one call, with compensating rollback on validation failuregenexus_edit_form — semantic WebForm editsgenexus_variable — Variables-part CRUDgenexus_create — creation umbrella (Transaction, Procedure, Domain, SDT, API, Folder, Module, curl_procedure = scaffold a Procedure from a curl command, …); object_atomic authors definition + variables + Rules + properties + Source with preflight/read-back/rollbackgenexus_data_view — atomically create/inspect/update/delete a root-only Business Component Transaction mapped through a native Data View to an existing physical table; validates attributes/keys first, supports optimistic versions and true no-mutation dry-runs, requires confirm=true for destructive delete, and reports commit/verification state separatelygenexus_delete_object — delete an object by native SDK identity; use dryRun=true to inspect incoming references before confirm=truegenexus_format — format a code snippet with the worker's rulesData model & structure authoring
genexus_structure — read/write the data model: get_visual/get_logic, update_visual (structure DSL), create_index/drop_index (unique/non-unique indexes — the GeneXus way to enforce uniqueness), set_attribute (Formula, subtype, Title/ColumnTitle, IsCollection, basedOnDomain), set_level (level Description/Image attribute), set_domain (edit an existing Domain's enum values / base type). For create_index, dryRun:true validates and returns the projected diff without saving; use the versionToken from get_indexes as baseVersion for concurrency protection. A real write is re-read and verified exactly, with snapshot rollback on failure. It never triggers Specify, Generate, Build, Rebuild, compilation, reorganization, execution, or tests.genexus_authoring — members of object types the structure DSL doesn't cover: add_external_method/add_external_property (External Objects), add_menu_option (Menus)genexus_properties — read/update object-level propertiesgenexus_generator_reference — list/preview/add/remove native .NET generator references with managed-assembly validation, optimistic concurrency, save/re-read verification, and exact full-snapshot rollback; never runs lifecycle actions implicitlyRefactor, patterns & compare
genexus_refactor — rename, extract procedure, WWP condition setgenexus_apply_pattern — apply a GeneXus pattern (WorkWith, WorkWithPlus, …); mode=actions manages typed WorkWithPlus grid actions and Action Groupsgenexus_wwp — typed WorkWithPlus editing: Action Groups, atomic native add_grid_attribute, plus add_tab, move_tab, and remove_tab for WebPanel tabs and typed childrengenexus_compare — IDE "Compare Objects" parity (IComparerService)genexus_merge — 2- or 3-way object merge (IMergeService)Analysis, docs & API
genexus_analyze — cross-object semantic analysis (impact, dependencies, complexity, naming, code_metrics, summary, kb_stats = KB activity/freshness, table_relations = table↔transaction relations + redundant attrs, …). mode=explain is compatibility-only: it preserves the legacy response envelope and returns NotImplemented; use mode=summary, mode=context, or genexus_read instead.genexus_dfd - read-only ER diagram of a Transaction/Table (extends/subordinates edges + Mermaid erDiagram) built only from the SDK table relationsgenexus_impact - read-only affected set of an object over the caller graph: counts by type, a dependencies-first rebuild order, cycles and the cap that truncated it (no risk score)genexus_object_context - read-only identity + callers/callees (with coverage) + data model of one object; a name shared by several objects is refused with their guids and pathsgenexus_doc — generate wiki / dependency graphs / health reportsgenexus_api — introspect REST endpoints exposed by HTTP proceduresgenexus_security — audit KB security: audit_gam (env/GAM props), scan_secrets (regex over Source), scan_native (the SDK's own Security Scanner, ISecurityScannerService)Lifecycle, build, test & DB
genexus_lifecycle — directed build (incl. compile_check), incremental global build_all, forced global rebuild, validate, index, reorg, and poll statusgenexus_test — run native GXtest testsgenexus_db — DB umbrella: schema-drift, sql_ddl/sql_navigation, static index advisor, sample_data, typed Transaction record query/insert/update with dry-run, optimistic versioning, reread and verified rollback, Domain/SDT type introspection, translation import, reorg_impact, and non-mutating reorg_preview with exact DDL only from a current Impact Analysis artifactgenexus_deploy — deploy application (IDeploymentService): list_targets (read) / deploy (destructive, confirm=true)genexus_run_object / genexus_browser — resolve runtime URL and headless-browser verificationNative layout / UI
genexus_layout — SDK layout/WebForm ops (get_tree, find_controls, set_property, add_printblock, get_preview, list_controls = control/theme-class catalog, design_system = DSO tokens/classes/images, …)KB pool, versioning & team dev
genexus_kb — multi-KB pool (list/open/close/set_default)genexus_module — Module Manager (IModuleManagerService)genexus_kb_version — model version/branch management (Create/Activate/Revert)genexus_versioning — versioning umbrella (git-style history over the KB)genexus_gxserver — GXserver / Team Development sync, incl. pipeline_* (CI pipelines via IContinuousIntegrationService)genexus_transfer — real XPZ export/import (IKnowledgeManagerService, dependency-aware): export / inspect / import (import previews by default: pass dryRun:false and confirm:true to actually import)genexus_memory — per-KB fact store for the agentSecurity provisioning, IO & meta
genexus_gam — GAM / integrated-security provisioning (IIntegratedSecurityService)genexus_io — assets, part-text exchange, screenshots, OCRgenexus_sdk_probe — dump the live SDK surface (types/methods/props) for capability discoverygenexus_worker_reload — hot-swap the worker without restarting the clientMulti-KB (v2.3.0+): every non-meta tool takes an optional
kbargument (alias or absolute path). The gateway can hold up toServer.MaxOpenKbs(default 3) KBs open at once, each in its own Worker process — calls to different KBs run truly in parallel. See Advanced Configuration for theKBs[]schema.
genexus_read / genexus_edit)PatternInstance / PatternVirtual XML: containers (<table>, groups), controls (<textBlock>, <attribute>, <gridAttribute>, <filterAttribute>, <errorViewer>), actions (<standardAction>, <userAction>), grids, orders, rules, event blocks. Transaction and Selection views are addressable independently.Documentation (markdown) and Help (HTML) are first-class write targets.themeClass, buttonClass, groupThemeClass, …); discover them with genexus_list_objects --typeFilter ThemeClass.Edit modes (genexus_edit): full (whole-part replacement, default), patch (Replace/Insert_After/Append over a context anchor — works on source code AND pattern XML), ops (typed semantic ops like set_attribute, add_rule for source-bearing parts).
Pattern XML auto-reconcile: WorkWithPlus encodes IDE rendering order in a per-parent childrenOrderedList attribute. The MCP now rebuilds (and creates if missing) every list from the actual XML child order on each write — callers only describe where an element goes in the tree and the MCP makes the IDE render it there. The response includes a childrenOrderedListReconciliation block listing each (re)written parent plus any structural elements that couldn't be inferred safely.
Safe by default: all write tools accept dryRun: true (returns a preview without mutating the KB) and idempotencyKey (safe retries; concurrent calls coalesce, results cached 15 min).
WorkWithPlus patterns are XML documents that drive Transaction-and-Selection screens. The MCP exposes the entire surface so an agent can design or restructure a screen without opening the IDE:
| Capability | Tool / pattern | Status |
|---|---|---|
Read PatternInstance / PatternVirtual XML | genexus_read --part PatternInstance | ✅ |
Replace whole pattern (mode: full) | genexus_edit --mode full --part PatternInstance | ✅ verified live |
Find/replace text-style patches (mode: patch) | genexus_edit --mode patch --part PatternInstance --operation Replace | ✅ verified live |
| Add / remove / reorder structural elements (textBlock, attribute, standardAction, table-as-group, order, filterAttribute, gridAttribute, eventBlock…) | XML edit + auto-reconcile | ✅ verified live |
Theme classes (themeClass, buttonClass, groupThemeClass, cellThemeClass, format="HTML") | XML attribute on the element | ✅ verified live |
| Reorganize Transaction view (form layout, action row) | edit under /instance/transaction/... | ✅ verified live |
| Reorganize Selection view (list/grid, filters, orders) | edit under /instance/level/selection/... | ✅ verified live |
Auto-rebuild childrenOrderedList from XML order | done implicitly on every write; report under childrenOrderedListReconciliation | ✅ verified live |
| Add / move / remove WebPanel tabs and typed controls | genexus_wwp add_tab / move_tab / remove_tab | ✅ native Pattern SDK commands; snapshot + re-read + WebForm projection verification |
| Add or reconcile one grid Attribute caption | genexus_wwp add_grid_attribute | ✅ isolated dry-run, full PatternInstance/WebForm snapshots, exact rollback and no implicit lifecycle |
Recommended workflow for a screen redesign:
genexus_list_objects --typeFilter ThemeClass --nameFilter Button — discover the actual button classes available in this KB (ButtonGreen, ButtonBlue, ButtonRed, etc — names vary per KB).genexus_read --name WorkWithPlus<Object> --part PatternInstance — get the current XML.<table isGroup="True" title="…" groupThemeClass="GroupTelaResp">, reorder buttons, add a new <standardAction>, attach buttonClass="btn ButtonGreen", etc.genexus_edit --mode full --part PatternInstance --content "<new xml>" — the MCP rewrites the part, reconciles childrenOrderedList on every container, and verifies the round-trip.Custom buttons use <userAction>, not <standardAction>. Trn_Enter / Trn_Cancel / Trn_Delete are the only registered standard actions on a WorkWithPlus transaction; any custom button (Duplicate, Audit, Export, etc.) must be a <userAction caption="…" name="…" buttonClass="btn ButtonGreen" confirm="False" />. The MCP's reconciler treats <userAction> as a peer of <standardAction> (same typeCode 17/18 by context), so they coexist in the same TableActions row and the IDE renders them side-by-side.
For WebPanel tabs, prefer the native typed operation instead of whole-XML replacement:
{
"action": "add_tab",
"name": "SamplePanel",
"controlName": "IntegrationV3",
"title": "Integration API V3",
"position": 5,
"children": [
{ "type": "variable", "name": "Operation", "basicType": "VarChar", "length": 40 },
{ "type": "userAction", "name": "SendIntegration", "caption": "Send" }
],
"dryRun": true
}
The dry-run returns a typed diff and versionToken. Pass it as baseVersion on the persisted call. The write uses Pattern SDK element commands, requires exact PatternInstance/WebForm snapshots, preserves Apply-on-save, re-reads the PatternInstance, projects and re-reads the parent WebForm, and rolls both parts back on any failed confirmation. It never invokes lifecycle operations.
Things to know (orientation, not gotchas):
title on top-level groups derives from the transaction's friendly name). When "Apply this pattern on save" is enabled on the WorkWithPlus object, the engine recomputes those fields — same behavior whether you edit in the IDE or via MCP. To make a hard override stick, toggle that flag via MCP:
{ "tool": "genexus_properties",
"arguments": { "action": "set", "name": "WorkWithPlus<Object>",
"propertyName": "SDPlus_Editor_Apply_On_Save", "value": "False" } }
Accepts "True" | "False" | "Default" (Default inherits the KB-level setting). Set back to "Default" to re-enable engine recomputation. Validated live in this repo.<transaction> without a <level>, or a <standardAction> whose name isn't a registered action), the SDK rejects the save and the MCP returns the exact error so you can fix the input. The KB never ends up half-written.buttonClass, themeClass, fonts, colors) is resolved at runtime, not in the preview canvas — so even after a successful MCP write the preview pane will look generic. To verify styling: open the element in the IDE tree and check the right-hand Properties panel (the applied classes show there), or hit Run / Live Editing to see the real CSS. This is GeneXus IDE behavior, independent of how the pattern was edited.The genexus-mcp command itself is also an agent-facing CLI with token-optimized output:
genexus-mcp status # gateway/worker state
genexus-mcp doctor --mcp-smoke # health check + protocol probe
genexus-mcp tools list # list available tools
genexus-mcp config show # current resolved config
genexus-mcp layout status # native layout automation state
Global flags: --format toon|json|text · --fields f1,f2,... · --limit N · --query <text> · --quiet · --no-color.
Full contract: docs/axi_cli_contract.md. Best-practices playbook: docs/llm_cli_mcp_playbook.md.
The installer writes a config.json for you. To customize networking, timeouts, or shadow paths:
{
"Server": {
"HttpPort": 5000,
"BindAddress": "127.0.0.1",
"SessionIdleTimeoutMinutes": 10,
"WorkerIdleTimeoutMinutes": 60,
"MaxOpenKbs": 3,
"ArtifactOutputDirectory": "C:\\GenexusMCP\\Artifacts"
},
"GeneXus": {
"InstallationPath": "C:\\Program Files (x86)\\GeneXus\\GeneXus18",
"WorkerExecutable": "worker\\GxMcp.Worker.exe"
},
"Environment": {
"DefaultKb": "main",
"KBs": [
{ "alias": "main", "path": "C:\\KBs\\YourKB" },
{ "alias": "legacy", "path": "C:\\KBs\\OtherKB" }
]
}
}
Backward compatibility: old configs with a single
Environment.KBPathkeep working — the gateway auto-migrates them toKBs[]+DefaultKbat load time.
genexus_doc keeps generated files outside the Worker installation so an update does not strand them in the install backup. By default the root is %LOCALAPPDATA%\GxMcp\Artifacts; each KB gets a stable kb-<identity> directory with docs and html children. Set Server.ArtifactOutputDirectory to choose another root; the per-KB child is still added. GXMCP_ARTIFACT_OUTPUT_DIR is the equivalent override for a directly launched Worker. Wiki responses report result.file; visualizer responses report result.url; both also report result.outputDirectory. Visualizer and health consume the active KB's canonical IndexCacheService snapshot, not a shared install-relative cache.
Once you declare more than one KB in Environment.KBs[], every tool accepts an optional kb argument:
// LLM example: list procedures in two KBs in parallel
{ "tool": "genexus_list_objects", "arguments": { "kb": "main", "type": "Procedure" } }
{ "tool": "genexus_list_objects", "arguments": { "kb": "legacy", "type": "Transaction" } }
Resolution rules when kb is omitted:
kb always wins; use it for parallel work or when a prompt touches more than one KBDefaultKb at initialize; set_default changes the current session and persists the startup fallback for future sessionsopen only starts/registers a Worker; it does not silently change another session's target. Select it with set_default, or pass kb explicitlyKB_AMBIGUOUS; choose one with set_default or pass kb explicitlyManage the pool at runtime:
{ "tool": "genexus_kb", "arguments": { "action": "list" } }
// → { selectedKb, activeKb, openKbs: [{alias, path, pid, workingSetMB, idleSeconds}], knownKbs, maxOpenKbs, defaultKb, declaredKbs }
{ "tool": "genexus_kb", "arguments": { "action": "open", "alias": "adhoc", "path": "C:/KBs/ScratchKB" } }
{ "tool": "genexus_kb", "arguments": { "action": "close", "alias": "legacy" } }
{ "tool": "genexus_kb", "arguments": { "action": "set_default", "alias": "main" } } // persists to config.json
For OpenCode, call genexus_whoami once at the start of a session. Use
kb.selected, kb.default, kb.openKbs, kb.knownKbs, and kb.declaredKbs
to understand the target, then select the normal working KB with
genexus_kb action=set_default. Every KB-bound response also includes kbAlias
in its JSON payload, which lets OpenCode correlate text-only responses. Keep
kb=<alias> on calls that intentionally compare or update another KB.
The installer registers both OpenCode configuration layouts: the legacy direct
mcp.genexus entry used by OpenCode 1.x and the current mcp.servers.genexus
layout. clients add --clients opencode is only needed to repair or explicitly
re-register a client after installation; normal init handles detected clients
automatically. Restart OpenCode after a registration so it reloads the MCP
configuration.
When the pool is full and no Worker is idle, the server returns KB_POOL_FULL — close one explicitly or raise Server.MaxOpenKbs. Each Worker carries the SDK in its own process (~200–400 MB idle, up to 1–2 GB on heavy KBs), so size the pool against available RAM.
graph LR
A[AI Client / Nexus-IDE] -->|MCP stdio or HTTP /mcp| B[Independent Gateway .NET 10]
B -->|isolated stdio: direct child| C[Worker .NET Framework 4.8]
B -->|shared-host: named-pipe attachment| H[Per-KB WorkerHost broker]
H -->|one compatible child| C
C -->|Native SDK| D[GeneXus KB]
MaxOpenKbs (default 3). With shared-host, compatible Gateways attach to one broker-owned Worker per physical KB instead of starting duplicate SDK processes. Workers are spawned lazily, recycled by WorkerIdleTimeoutMinutes, and evicted LRU when the pool is full.shared-host does not turn one Gateway into a master or proxy for another; each client keeps its own MCP state and only the SDK Worker is shared.%LOCALAPPDATA%\GenexusMCP\gateway-leases.http://127.0.0.1:5000/mcp with SSE. Header: MCP-Protocol-Version: 2025-11-25.Want to contribute or run a local dev build?
.\build.ps1 to restore and build the C# components and package the local artifacts. The script checks for the required .NET SDK and GeneXus 18 installation.$env:GX_PATH to its installation folder before running the build. A Knowledge Base is only needed for runtime testing..gemini/skills/)This repo ships a set of agent skills under .gemini/skills/ that any MCP-compatible client with skill support (Gemini CLI, Claude Code via plugin, etc.) can load to ground its GeneXus reasoning:
| Skill | What it gives the agent |
|---|---|
genexus-mastery | This repository's preferred MCP workflow + multi-KB usage |
genexus18-guidelines | Local engineering rules layered on top of Nexa |
nexa | Full reference set for the primary GeneXus SDK: every object type, command, type, property — imported from the official genexuslabs/genexus-skills |
frontend/chameleon-controls-library | 58 Chameleon UI component specs |
frontend/mercury-design-system | Mercury tokens, bundles, theming |
frontend/design-system-builder | Authoring custom design systems |
frontend/ui-creator | Panel/screen generation templates |
Third-party skills are Apache 2.0 (see .gemini/skills/NOTICE.md). To refresh against upstream, follow the steps in NOTICE.md.
src/nexus-ide is a lightweight, experimental VS Code extension in the repo. The installer no longer packages or installs it — VS Code is wired up as a native MCP client instead (see Supported AI clients). If you want the extension, build and install it manually:
cd src/nexus-ide; npm ci; npm run compile
npx --yes @vscode/vsce package --out nexus-ide.vsix
code --install-extension nexus-ide.vsix --force
It provides a virtual filesystem (genexus:// scheme), a KB explorer with multi-part editing, and MCP discovery commands.
Releases ship through release.ps1; the full protocol is in docs/release_protocol.md.
./release.ps1 -Version <X.Y.Z> builds the artifacts, creates the v<version> tag and the GitHub Release (with publish.zip, its checksum and the Nexus VSIX attached). Nothing is published by a push to main..github/workflows/release.yml on the release: [published] event; a manual workflow_dispatch with a tag re-runs it for a release that already exists. The workflow verifies the release's assets and publishes the package to npm — it does not create the tag or the release.MIT — see LICENSE.
Search keywords: GeneXus MCP · GeneXus 18 MCP · GeneXus AI · GeneXus Claude · Model Context Protocol GeneXus · GeneXus low-code AI agent · GeneXus Cursor · GeneXus Antigravity