This guide walks you through using the MkDocs MCP Server for the first time.
After installation, ask your AI assistant:
Can you list my documentation files?
The assistant will use the list_docs tool to show all markdown files in your docs directory.
Ask your assistant to create a new documentation page:
Create a new documentation page at api/users.md about the Users API endpoint.
Include a title in the frontmatter.
The assistant will use the create_doc tool to create the file with proper structure.
Search across all your documentation:
Search my docs for "authentication"
The assistant will use the search_docs tool to find all mentions.
Reorganize your documentation structure:
Add the new Users API page to the navigation under an API section
The assistant will use get_navigation and update_navigation tools to modify your mkdocs.yml.
Create the following documentation pages:
- getting-started/installation.md
- getting-started/quick-start.md
- api/authentication.md
Update the installation.md file to add a new prerequisite: Docker
Search for all mentions of "Python 3.7" and help me update them to "Python 3.8"
Show me the current navigation structure
Reorganize the navigation to put Getting Started before API docs