Skip to content

docs(profile): collapse the AI-agents section to one paragraph + guide link#44

Merged
rafael5 merged 1 commit into
mainfrom
docs/shorten-readme-ai-section
May 11, 2026
Merged

docs(profile): collapse the AI-agents section to one paragraph + guide link#44
rafael5 merged 1 commit into
mainfrom
docs/shorten-readme-ai-section

Conversation

@rafael5
Copy link
Copy Markdown
Contributor

@rafael5 rafael5 commented May 11, 2026

Summary

The "For AI agents and automated tooling" section in profile/README.md had bloated with the .mcp.json snippet, per-tool one-liners, direct-catalog fallback, manifest pointers, and Phase-5 enforcement-gate namedrops. All of that is in ai-users-guide.md now — the README's job is to point at the guide, not duplicate it.

Before / after

  • Before: ~24 lines (heading + 3 paragraphs + JSON block + manifest-pointer bullets).
  • After: 1 short paragraph naming the MCP server, both publish channels (PyPI + the official MCP registry under io.github.m-dev-tools/m-dev-tools-mcp), the three tools, and a deep link to the users guide.

Manifest-pointer bullets were a Phase-1-era shortcut from before tools.json existed; the catalog has them now (any agent will resolve module:m-stdlib#STDJSONmodules_url via describe).

Verified

make check-docs-prose / check-freshness / check-links / check-licenses / check-schema-compat / recipes-check / handshake / validate-catalog — all clean.

Test plan

  • All 8 local gates green
  • CI green

…e link

The "For AI agents and automated tooling" section had bloated with
the .mcp.json snippet, per-tool one-liners, direct-catalog
fallback, manifest pointers, and Phase-5 enforcement-gate
namedrops. All of that is in the AI users guide now — the
README's job is to point there, not duplicate it.

One short paragraph: name the MCP server, link both PyPI + the
official MCP registry listing under the canonical namespace, name
the three tools, link the users guide as the deep entry.

Manifest-pointer bullets removed too — they were a Phase-1-era
shortcut from before tools.json existed; the catalog has them now.
@rafael5 rafael5 merged commit 3e0e2b1 into main May 11, 2026
2 checks passed
@rafael5 rafael5 deleted the docs/shorten-readme-ai-section branch May 11, 2026 19:49
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

1 participant