RFC: Self-describing syntax feature registry for LLM-friendly help discovery#172
Draft
engalar wants to merge 1 commit intomendixlabs:mainfrom
Draft
RFC: Self-describing syntax feature registry for LLM-friendly help discovery#172engalar wants to merge 1 commit intomendixlabs:mainfrom
engalar wants to merge 1 commit intomendixlabs:mainfrom
Conversation
…y help discovery Current help system is flat (26 monolithic .txt topics) with no drill-down, no structured output, and no way for LLMs to bridge from business concepts to MDL syntax. Proposes a SyntaxFeature registry where each syntax construct self-registers with metadata (path, summary, keywords, example), enabling: - `mxcli syntax --json` for one-shot LLM discovery - Hierarchical drill-down (workflow → user-task → targeting) - Single-file changes when adding new features
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
1 participant
Add this suggestion to a batch that can be applied as a single commit.This suggestion is invalid because no changes were made to the code.Suggestions cannot be applied while the pull request is closed.Suggestions cannot be applied while viewing a subset of changes.Only one suggestion per line can be applied in a batch.Add this suggestion to a batch that can be applied as a single commit.Applying suggestions on deleted lines is not supported.You must change the existing code in this line in order to create a valid suggestion.Outdated suggestions cannot be applied.This suggestion has been applied or marked resolved.Suggestions cannot be applied from pending reviews.Suggestions cannot be applied on multi-line comments.Suggestions cannot be applied while the pull request is queued to merge.Suggestion cannot be applied right now. Please check back later.
Summary
.txttopics) — no drill-down, no structured output, no LLM-friendly discoverySyntaxFeatureregistry where each syntax construct self-registers with metadata (path, summary, keywords, example)mxcli syntax --jsonfor one-shot LLM discovery, hierarchical drill-down, and single-file changes for new featuresKey Design Decisions (seeking feedback)
syntax/package — keeps syntax docs out of executor logicdomain.concept.detail— e.g.workflow.user-task.targetingHELP <topic>in MDL REPL — requires grammar change, worth it?Design Doc
See
docs/11-proposals/syntax-feature-registry.mdTest plan
HELP <topic>grammar change is worthwhile🤖 Generated with Claude Code