Skip to content

docs(profile): README polish — heading wording + section reorder #51

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
rafael5 merged 3 commits into from
May 12, 2026
Merged

docs(profile): README polish — heading wording + section reorder #51

Changes from all commits
Commits
Show all changes
3 commits
Select commit Hold shift + click to select a range
b5b5c20
docs(profile): README polish
rafael5 May 12, 2026
92172e4
docs(profile): README polish, follow-up
rafael5 May 12, 2026
cf0b25f
docs(profile): collapse "AI-integrated out-of-the-box" H3 to inline bold
rafael5 May 12, 2026
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
41 changes: 13 additions & 28 deletions profile/README.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -19,29 +19,25 @@ containerized test engine
([`m-test-engine`](https://github.com/m-dev-tools/m-test-engine)), and
editor integrations, they form an end-to-end TDD stack that works
identically for **InterSystems IRIS** and **YottaDB** developers
maintaining modern (non-VistA) M code.
maintaining modern (pythonic) M code, as well as large legacy (VistA) M code.

## AI-integrated out-of-the-box
**AI-integrated out-of-the-box**. m-dev-tools ships an MCP server ([`m-dev-tools-mcp`](https://pypi.org/project/m-dev-tools-mcp/), also listed on the [official MCP registry](https://registry.modelcontextprotocol.io/) as `io.github.m-dev-tools/m-dev-tools-mcp`) that exposes `route_intent` / `describe` / `verify` over the catalog so any MCP-capable agent (Claude Code, Codex, Continue, …) can resolve plain-English M-tooling intent without guessing. See the [**AI users guide**](../docs/ai-discoverability/ai-users-guide.md) for install paths (PyPI, `.mcp.json`, registry-driven), example sessions, and the no-MCP fallback that walks `tools.json` directly.

m-dev-tools ships an MCP server ([`m-dev-tools-mcp`](https://pypi.org/project/m-dev-tools-mcp/), also listed on the [official MCP registry](https://registry.modelcontextprotocol.io/) as `io.github.m-dev-tools/m-dev-tools-mcp`) that exposes `route_intent` / `describe` / `verify` over the catalog so any MCP-capable agent (Claude Code, Codex, Continue, …) can resolve plain-English M-tooling intent without guessing. See the [**AI users guide**](../docs/ai-discoverability/ai-users-guide.md) for install paths (PyPI, `.mcp.json`, registry-driven), example sessions, and the no-MCP fallback that walks `tools.json` directly.

## The need for M Dev Tools

## Why we need modern M Developer Tools
M (MUMPS) is the language supporting a great deal of healthcare and financial
infrastructure worldwide, but its modern developer tooling has historically lagged
behind mainstream languages. The 2026 cross-engine gap analysis ([`docs/history/m-tools-gap-analysis.md`](../docs/history/m-tools-gap-analysis.md)) inventoried the deficit — no test runner, no logic linter, no formatter, no single-test selection, no test watcher — and ranked the missing pieces into [four impact tiers](../docs/history/m-tools-gap-analysis.md#8-rank-ordered-developer-impact-where-to-invest-first).

M (MUMPS) is the language behind a great deal of healthcare and financial
infrastructure, but its modern developer tooling has historically lagged
behind mainstream languages. The 2026 cross-engine gap analysis
([`docs/history/m-tools-gap-analysis.md`](../docs/history/m-tools-gap-analysis.md)) inventoried the deficit — no test runner, no logic linter, no formatter,
no single-test selection, no test watcher — and ranked the missing pieces
into [four impact tiers](../docs/history/m-tools-gap-analysis.md#8-rank-ordered-developer-impact-where-to-invest-first).
**`m-dev-tools`** is the focused remediation of that top tier: the
**inner development loop** that mainstream language ecosystems take for
granted and that M has never had.
**`m-dev-tools`** is the focused remediation of that top tier: the **inner development loop** that mainstream language ecosystems take for granted and that M has never had. **`m-dev-tools`** also provides a portable, industry-conformant **M standard library** which has not existed to date, enabling rapid development of applications without re-inventing wheels.


## M Dev Tools: A walkthrough

The [M test-driven-development walkthrough](../docs/guides/m-tdd-stdlib-walkthrough.md) is an end-to-end transcript of building a small data-analysis app — `reqstats`, an HTTP-access-log summarizer — using only the `m` toolchain and `m-stdlib`. Exercises every `m <subcommand>` (fmt /
lint / test / coverage / watch / lsp / new / run / build / ci) and the M standard library it consumes. The fastest way to see modern test-driven development with continuous integration on a clean host.

The toolchain is **engine-neutral at the source layer** (`m fmt` and
`m lint` care about M syntax, not a specific runtime), so a working
install serves IRIS, YottaDB, and any future ANSI-compliant M engine
equally.


## Getting started
Expand All @@ -55,17 +51,6 @@ less ./setup.sh
bash ./setup.sh
```

## Example of M Test-Driven Development with the M Standard Library

The [m-cli TDD lifecycle walkthrough](../docs/guides/m-tdd-stdlib-walkthrough.md)
is an end-to-end transcript of building a small data-analysis app —
`reqstats`, an HTTP-access-log summarizer — using only the `m`
toolchain and `m-stdlib`. Exercises every `m <subcommand>` (fmt /
lint / test / coverage / watch / lsp / new / run / build / ci) and
the standard library it consumes. The fastest way to see a modern
M inner loop in action on a clean host.



## Repositories

Expand Down
Loading