bm.md

更好用的 Markdown 排版助手｜一键适配微信公众号、网页与图片。

Installation

Run this command in your terminal to add the MCP server to Claude Code.

Run in terminal:

Command

claude mcp add --transport stdio miantiao-me-bm.md node dist/server/server.js \
  --env PORT="Port to run the MCP server (default 2663)" \
  --env BASE_URL="Base URL of the server if behind a proxy or for MCP callbacks (optional)"

How to use

bm.md exposes an MCP-enabled server for the bm.md project, enabling REST API access and MCP protocol integration to automate and orchestrate tasks such as rendering Markdown, exporting content, and interacting with the editor features. The server is designed to run as a Node.js process that serves the Nitro-based build (dist/server/server.js). Once started, you can communicate with it via the MCP protocol to perform operations defined by the API surface, such as converting Markdown to different formats, exporting images, or invoking editor actions remotely. Use the provided REST API alongside MCP calls to integrate bm.md into your automation pipelines or other MCP-enabled tooling.

Typical usage flow:

Start the server (production: after building, e.g., node dist/server/server.js).
Use MCP requests to trigger rendering, export, or feature actions, or query server status via REST endpoints documented in the API docs.
Configure environment variables as needed (PORT for the listening port, BASE_URL if behind a reverse proxy) to align with your deployment environment.

How to install

Prerequisites:

Node.js (version 18 or later recommended)
pnpm (or npm/yarn as an alternative)
Git

Installation steps:

Clone the repository git clone https://github.com/miantiao-me/bm.md.git cd bm.md
Install dependencies pnpm install
Build the project (produces dist/server/server.js for production) pnpm build
Run the development server (for local testing) pnpm dev
Run the production server (after building) node dist/server/server.js

Notes:

If you use Docker, you can adapt the produced dist/server/server.js into a container command as needed for your environment.

Additional notes

Tips and common considerations:

The server serves on port 2663 by default; override with PORT in the environment if needed.
If deploying behind a reverse proxy, set BASE_URL to the public URL and ensure your proxy forwards MCP/WebSocket requests properly.
For Cloudflare/Vercel/Nitro deployments, follow the Nitro deployment guidance cited in the README and map the built dist/server/server.js accordingly.
When upgrading dependencies, re-run pnpm install and rebuild to ensure the dist/server/server.js is up to date.
The MCP integration is designed to work with REST API endpoints as documented in the project docs; consult the API docs for available endpoints and request/response formats.