docusaurus-plugin-mcp-server AGENTS.md

Project instructions for a Docusaurus plugin that exposes documentation to AI assistants through an MCP server. Docusaurus is a tool for building documentation websites, and the plugin converts built HTML pages into searchable Markdown data.

In plain words
What is it for?
Use them to build, develop, lint, type-check, and test the plugin, including individual Vitest tests and Playwright MCP tests.
Why use it?
They explain how documentation is processed at build time and how to check the plugin with linting, type checks, unit tests, and integration tests.

Instructions file for CodexOpenCode

Install

Getting it into your agent

One page per mod, every tool's command on it. A separate URL per tool would split the same page into five that compete with each other.

agentmods
npx agentmods add instructions/scalvert/docusaurus-plugin-mcp-server/agents-md
Clone the repo
git clone --depth 1 https://github.com/scalvert/docusaurus-plugin-mcp-server

Made for: Codex, OpenCode.

Per session 714 This file is loaded in full into every session.
When invoked 714 The same file — it is already loaded in full.
Security scan A 0 findings. Scan, not verified.
Origin original No closer match found in the catalogue.
Token cost

What it costs to keep this loaded

Counted locally with the o200k_base tokenizer, which is exact for GPT models; Claude uses its own tokenizer and its counts differ. Treat this as one consistent yardstick across the catalogue rather than a bill. Prices are per million input tokens.

ModelPer sessionOnce invoked
Fable 5 $0.00714 $0.00714
Opus 5 $0.00357 $0.00357
Sonnet 5 $0.00143 $0.00143
Haiku 4.5 $0.00071 $0.00071

Measured 2d ago against content hash cc56bd0f2b6c, method: parsed. Prices are Anthropic first-party input rates as of 2026-08-30, from the pricing page.

Security

Grade A, and why

docusaurus-plugin-mcp-server AGENTS.md scanned grade A with 0 findings against 26 rules in 11 categories — prompt injection, anti-refusal, data exfiltration, privilege escalation, supply chain, agent snooping, system-prompt leakage, SSRF and excessive agency — measured 2d ago.

A static scan of the body, not an audit. Every finding is printed with the line that produced it so you can judge whether it matters here. A mod is markdown that instructs an agent; that is exactly why what it instructs is worth reading.

Nothing flagged

None of the 26 patterns this scan looks for appear in this file: no shell pipes, no recursive deletes, no credential paths, no hidden text, no instruction-override or anti-refusal phrasing, no agent-config snooping. That is not a guarantee, it is the absence of the things that are checkable.

AGENTS.md · 74 lines

How it starts

The opening of the file, as written. The whole thing — 74 lines — stays where its author put it; the contents beside it link to each section on GitHub.

AGENTS.md

This file provides guidance to Claude Code (claude.ai/code) when working with code in this repository.

Build and Development Commands

npm run build          # Build with tsup (ESM-only output)
npm run dev            # Watch mode for development
npm run lint           # Run ESLint and Prettier check
npm run lint:fix       # Auto-fix lint issues
npm run typecheck      # TypeScript type checking
npm run test           # Run unit tests with Vitest
npm run test:watch     # Run tests in watch mode
npm run test:mcp       # Run Playwright MCP integration tests
npm run test:all       # Run lint, typecheck, and all tests

Run a single test file:

npx vitest run tests/html-to-markdown-test.ts

Architecture Overview

This is a Docusaurus plugin that exposes documentation as an MCP (Model Context Protocol) server for AI agents.

Two-Phase Design

Build Time (src/plugin/): The Docusaurus plugin runs during docusaurus build:

  • docusaurus-plugin.ts - Main plugin with postBuild hook
  • Processes HTML files → extracts content → converts to markdown → builds search index
  • Outputs artifacts to build/mcp/ (docs.json, search-index.json, manifest.json)

Runtime (src/mcp/, src/adapters/): Serverless functions serve MCP requests:

  • McpDocsServer class wraps the official MCP SDK
  • createWebRequestHandler — one generic web-standard (Request) => Response handler for any serverless/edge runtime (pre-loaded data)
  • createNodeServer/createNodeHandler — local-dev server over Node http (file-based)

Entry Points

The package has three export paths configured in package.json:

  • . → Main plugin + MCP server (src/index.ts)
  • ./adapters → Platform handlers (src/adapters-entry.ts)
  • ./theme → React components (src/theme/index.ts)

Key Modules

  • src/mcp/server.ts - Core MCP server using @modelcontextprotocol/sdk
  • src/mcp/tools/ - MCP tool definitions (docs_search, docs_fetch)
  • src/processing/ - HTML parsing, markdown conversion, heading extraction
  • src/search/ - FlexSearch integration for full-text search
  • src/providers/ - Pluggable indexer/search provider system
  • src/cli/verify.ts - CLI for verifying build output

Read the full file on GitHub · 74 lines

Changes

What this file has done since we first saw it

Hashed on every crawl. A supply-chain change to an agent config is a question of when, not whether, so the history is kept rather than the latest state alone.

  1. 2d ago First seen · 74 lines · 714 tokens per session scan A cc56bd0f2b6c

Subscribe to this mod's changes

docusaurus-plugin-mcp-server AGENTS.md is an instructions file published in the GitHub repository scalvert/docusaurus-plugin-mcp-server (31 stars, last pushed 1mo ago), licensed MIT. It adds 714 tokens to every session, about $0.0036 per session on Opus 5. A static security scan graded it A with 0 findings. No closer match exists in the catalogue, so it is treated as the original; first seen 2026-08-30.

Related

Other instructions, from other repositories

spec-kit AGENTS.md

AGENTS.md instructions for github/spec-kit, covering agents.md, about spec kit and specify, quickstart — add a new integration in 5 steps, integration architecture and integrationmanifest — file tracking.

github/spec-kit · 7,104 tokens

codex AGENTS.md

AGENTS.md instructions for openai/codex, covering rust/codex-rs, the codex-core crate, code review rules, crate api surface and model visible context.

openai/codex · 5,182 tokens

vscode buildNext.instructions.md

Working notes and architecture documentation for the new esbuild-based build system in build/next. Use when making changes to the new build pipeline (transpile/bundle commands, NLS plugin, source-map handling, resource copying, or self-hosting watch tasks).

microsoft/vscode · 6,785 tokens

langchain AGENTS.md

AGENTS.md instructions for langchain-ai/langchain, covering global development guidelines for the langchain monorepo, corridor security analysis, project architecture and context, monorepo structure and development tools & commands.

langchain-ai/langchain · 4,345 tokens

vscode oss-third-party-notices.instructions.md

Instructions for microsoft/vscode, covering vs code oss third-party-notices pipeline, architecture, pipeline flow in ci, applying the notice (cutover) and fallback chain (never fail the build).

microsoft/vscode · 5,001 tokens

next.js AGENTS.md

Instructions for vercel/next.js, covering next.js development guide, codebase structure, monorepo overview, core package: packages/next and other important packages.

vercel/next.js · 7,296 tokens