setup-docusaurus-mcp

Getting started

Done when

curl http://localhost:3456 returns the server status with "initialized": true and a docCount above 0.

Before you start

• A Docusaurus 3 site. Check: npm ls @docusaurus/core shows a 3.x version.
• Node.js 22 or later. Check: node --version.

How to use this guide

• Do the steps in order. Run them yourself, or walk the user through them one at a time if they'd rather do it themselves or you can't run them.
• After each step, run its check. Don't move on until it passes.
• If a check fails, look for the matching symptom under Troubleshooting. If none matches, stop and tell the user what you saw.
• A step marked Needs the user needs a person. Tell the user what to do and wait for them to confirm it's done.
• Ask the user before running a step marked Confirm first.
• Don't ask the user to paste passwords, tokens, or keys into the chat. When a step needs one, tell the user where to put it.

Steps

1. Install the plugin {#install}

npm install docusaurus-plugin-mcp-server

Check: npm ls docusaurus-plugin-mcp-server lists the package.

If the check fails: see Troubleshooting.

2. Add it to your config {#configure}

// docusaurus.config.js
module.exports = {
  plugins: [
    [
      'docusaurus-plugin-mcp-server',
      {
        server: {
          name: 'my-docs',
          version: '1.0.0',
        },
      },
    ],
  ],
};

server.name is the name agents see for your server. Every option is optional; see Plugin options.

Set your site's url

Every page URL the server returns is built from url in docusaurus.config.js at build time. If it still says https://your-docusaurus-site.example.com, agents get links to that. Set it to your production domain before you build for production.

If url is still the Docusaurus default, ask the user for their production domain. Don't guess it.