Enables reading, searching, converting, and extracting metadata from MDX files, with tools for converting MDX to Markdown format and performing contextual content searches.
Click on "Install Server".
Wait a few minutes for the server to deploy. Once ready, it will show a "Started" state.
In the chat, type
@followed by the MCP server name and your instructions, e.g., "@MDX MCP Serverconvert the docs/guide.mdx file to markdown for me"
That's it! The server will respond to your query, and you can continue using it as needed.
Here is a step-by-step guide with screenshots.
MDX MCP Server is a powerful Model Context Protocol server that enables LLMs to seamlessly interact with, search, and process MDX files. It provides robust tools for reading MDX content as clean Markdown, performing contextual searches, converting files, and extracting metadata, all with built-in cross-platform compatibility and security.
The server exposes the following tools through the Model Context Protocol interface.
See how the tools can be leveraged to interact with MDX files.
// Read an MDX file
{
"name": "read_mdx",
"arguments": {
"path": "docs/introduction.mdx"
}
}
// Search with context
{
"name": "search_mdx",
"arguments": {
"path": "docs/guide.mdx",
"query": "installation",
"contextLines": 2
}
}
// Convert MDX to Markdown
{
"name": "convert_mdx_to_md",
"arguments": {
"sourcePath": "docs/guide.mdx",
"outputPath": "output/guide.md"
}
}
// Extract metadata
{
"name": "get_mdx_frontmatter",
"arguments": {
"path": "docs/article.mdx"
}
}Prerequisites
Ensure you have Node.js installed:
# Node.js >= 20.19.0 is required
node --versionInstall the MCP Server
npm install
npm run buildAdd to your MCP settings file (e.g., claude_desktop_config.json):
{
"mcpServers": {
"mdx": {
"command": "node",
"args": ["/absolute/path/to/mdx-mcp-server/dist/index.js"],
"env": {
"WORKSPACE_ROOT": "/path/to/your/workspace"
}
}
}
}# Clone the repository
git clone https://github.com/LLMTooling/mdx-mcp-server.git
cd mdx-mcp-server
# Install dependencies
npm install
# Build the project
npm run build
# Run tests
npm test
# Run tests in watch mode
npm run test:watchThe server follows a modular architecture ensuring clean separation of concerns.
Contributions are welcome! Please feel free to submit issues or pull requests.
MIT License