H1 MCP API¶

The SDK that lets any Magnolia module expose its content to an AI assistant: the tool contract, two dynamic registries (h1McpTools/ and h1McpPublicTools/), the content-type tool base with its fourteen standard actions, and the introspection, validation and i18n helpers they share. A module depends on this API and never on the MCP server; this API depends on no domain module.

Version 1.0.0-SNAPSHOT · Magnolia 6.4 · Java 21 · artifact com.habito1:h1-mcp-api

No light module, no REST endpoint, no workspace, no content of its own. It registers and runs tools; h1-mcp is what exposes them.

Documentation¶

The documentation lives in docs/ and is published at /modules/h1-mcp-api/ on the H1 docs site. This file is not the documentation.

• Overview — what the module is, its seven features, its requirements.
• Authors — what an assistant may do to a content manager's content, what it asks before doing it, and what it refuses.
• Developers · Installation — coordinates, the optional dependency pattern, how to register and write a tool, and why a tool stays inert without a transport.
• Developers · Configuration — every YAML key, the fourteen actions and their parameters, the validation pipeline, the three guards, and the full helper reference.
• Troubleshooting — symptom to cause, silent failures first.

Build¶

mvn clean install

Requires access to the H1 Nexus repositories; see Developers · Installation.