mf-docs
Module Federation Docs Assistant
Answer Module Federation questions by fetching only the relevant documentation pages — not the entire docs.
Steps
1. Fetch the documentation index
Fetch the index to discover available pages and their descriptions:
https://module-federation.io/llms.txt
The index is in this format:
## Section Name
- [Page Title](/path/to/page.md): brief description of the page content
2. Identify the relevant page(s)
Read the page descriptions in the index and select the 1–3 pages most relevant to the user's question. Use the quick topic map below to narrow down candidates before reading descriptions.
Quick topic map:
| User asks about | Look in section |
|---|---|
| What is MF / concepts / glossary / getting started | Guide → start/ |
| CLI, CSS isolation, type hints, data fetching, prefetch | Guide → basic/ |
Runtime API, loadRemote, MF instance, runtime hooks |
Guide → runtime/ |
| Build plugin setup for Webpack / Rspack / Rsbuild / Vite / Metro | Guide → build-plugins/ |
| Next.js / Modern.js / Angular / React integration | Guide → framework/ or Practice → frameworks/ |
| React Bridge / Vue Bridge / cross-framework rendering | Practice → bridge/ |
name, filename, exposes, remotes, shared, dts, manifest, shareStrategy |
Configuration |
| Runtime plugins, retry plugin, custom plugin | Plugins |
| Performance, tree shaking, shared scopes | Guide → performance/ or Guide → advanced/ |
| Debug mode, Chrome DevTool, global variables | Guide → debug/ |
| Error messages, build errors, type errors | Guide → troubleshooting/ |
| Monorepo, Nx | Practice → monorepos/ |
| Deployment, Zephyr | Guide → deployment/ |
3. Fetch the specific page(s)
Construct the URL by removing the .md extension from the path in the index, then prepend the base URL:
https://module-federation.io{path_without_md_extension}
Examples:
/guide/start/index.md→https://module-federation.io/guide/start/index/configure/shared.md→https://module-federation.io/configure/shared/guide/runtime/runtime-api.md→https://module-federation.io/guide/runtime/runtime-api
Fetch the page(s) and read the content.
4. Answer the question
Answer based on the fetched content. If the answer spans multiple pages (e.g., config + runtime), fetch both. Do not load more than 3 pages per question.
Important notes
- Always fetch the index first — never guess page paths from memory
- If the index descriptions are insufficient to identify the right page, fetch the most likely candidate and check its content
- The docs cover MF 2.0 (
@module-federation/enhanced) — this is different from the older Webpack 5 built-in Module Federation - Next.js support is deprecated; inform the user if they ask about it
More from module-federation/core
mf
All-in-one Module Federation skill. Use when the user asks anything about MF — concepts, configuration, runtime API, shared dependencies, type errors, runtime error code troubleshooting, slow builds, Bridge integration, or adding MF to an existing project.
411mf-integrate
Integrate Module Federation into an existing project — add provider (exposes modules) or consumer (loads remote modules) configuration. Use when the user wants to add Module Federation to an existing Rsbuild / Rspack / Webpack / Modern.js / Next.js / Vite project, set up a remote, create a host app, or quickly consume the demo provider to see MF working. Default role is consumer.
107mf-context
Collects the current project's Module Federation context (MFContext) and outputs a structured summary. Serves as the data foundation for all MF diagnostic Skills; can also be called standalone to quickly understand the project's MF configuration.
66mf-shared-deps
Check Module Federation shared dependency configuration: detect shared/externals conflicts, antd/arco transformImport blocking shared deps, and multiple versions of the same shared package in build artifacts. Use when shared dependencies fail to be shared, or host and remote load duplicate instances of a library.
61mf-perf
Check Module Federation local development performance configuration: detect whether recommended performance optimization options are enabled to alleviate slow HMR and slow build speed.
60mf-config-check
Check Module Federation build configuration: verify correct MF plugin for the bundler, async entry configuration, exposes key format, and exposes path existence. Use when modules cannot be correctly exposed, expected modules are missing from the build output, or runtime initialization errors occur.
56