This guide covers how to set up and preview the MCP Java SDK documentation locally.

!!! info "Prerequisites" - Python 3.x - pip (Python package manager)

Install mkdocs-material:

pip install mkdocs-material

From the project root directory, run:

mkdocs serve

A local preview of the documentation will be available at http://localhost:8000.

By default, mkdocs uses port 8000. You can customize the port with the -a flag:

mkdocs serve -a localhost:3333

To build the static site for deployment:

mkdocs build

The built site will be output to the site/ directory.

docs/
├── index.md            # Overview page
├── quickstart.md       # Quickstart guide
├── client.md           # MCP Client documentation
├── server.md           # MCP Server documentation
├── contributing.md     # Contributing guide
├── development.md      # This page
├── images/             # Images and diagrams
└── stylesheets/        # Custom CSS
mkdocs.yml              # MkDocs configuration

• Documentation pages use standard Markdown with mkdocs-material extensions
• Use content tabs (=== "Tab Label") for Maven/Gradle or Sync/Async code examples
• Use admonitions (!!! tip, !!! info, !!! warning) for callouts
• All code blocks should specify a language for syntax highlighting
• Images go in the docs/images/ directory

We suggest using extensions on your IDE to recognize and format Markdown. If you're a VSCode user, consider the Markdown All in One extension for enhanced Markdown support, and Prettier for code formatting.