Overview
All docs tools are created viacreateDocTools() which accepts:
create_doc
Create a new documentation file with frontmatter and sections. Automatically registers the page in docs.json navigation.Parameters
path(required): Path for the new doc file relative to docs roottitle(required): Title for the documentdescription(required): Brief description of the documentsections(required): Array of sections to includenavGroup(optional): Navigation group in docs.json to add this page to
Usage
Returns
read_doc
Read the contents of a documentation file or a specific section.Parameters
path(required): Path to the doc file relative to docs rootsection(optional): Section id or heading to read
Usage
Returns
get_doc_outline
Get the hierarchical outline of a documentation file.Parameters
path(required): Path to the doc file relative to docs root
Usage
Returns
update_section
Update the content of a specific section in a documentation file.Parameters
path(required): Path to the doc file relative to docs rootsection(required): Section id or heading to updatecontent(required): New content for the section
Usage
add_section
Add a new section to an existing documentation file.Parameters
path(required): Path to the doc file relative to docs rootheading(required): Heading for the new sectioncontent(required): Content for the new sectionlevel(optional, default: 2): Heading level (1-6)afterSection(optional): Insert after this section (id or heading). If omitted, appends to end
Usage
delete_section
Delete a section from a documentation file.Parameters
path(required): Path to the doc file relative to docs rootsection(required): Section id or heading to delete
Usage
delete_doc
Delete an entire documentation file. Use with caution.Parameters
path(required): Path to the doc file relative to docs rootconfirm(required): Must be true to confirm deletion
Usage
move_section
Move a section to a different position within the same document.Parameters
path(required): Path to the doc file relative to docs rootsection(required): Section id or heading to moveafterSection(required): Move after this section (null = move to beginning)
Usage
move_content
Move content from one document to another.Parameters
sourcePath(required): Source doc path relative to docs rootsourceSection(required): Section to move from sourcetargetPath(required): Target doc path relative to docs rootafterSection(optional): Insert after this section in target (omit to append)
Usage
rename_doc
Rename or move a documentation file to a new path.Parameters
oldPath(required): Current path relative to docs rootnewPath(required): New path relative to docs root
Usage
consolidate_docs
Consolidate multiple related documentation files into one, preserving all content.Parameters
sourcePaths(required): Array of paths to consolidate (minimum 2)targetPath(required): Path for the consolidated doctitle(required): Title for the consolidated docdescription(required): Description for the consolidated doc
Usage
search_docs
Search documentation using semantic search (for concepts) or text search (for exact terms).Parameters
query(required): The search querytype(optional, default: ‘hybrid’): Search type - ‘semantic’, ‘exact’, or ‘hybrid’limit(optional, default: 5): Maximum results to return
Usage
analyze_doc
Analyze a documentation file for quality issues, structure problems, and potential improvements.Parameters
path(required): Path to the doc file relative to docs root
Usage
Returns
check_coverage
Check if a topic or feature is covered in the documentation.Parameters
topic(required): The topic or feature to check coverage for
Usage
Returns
Navigation tools
read_nav
Read and analyze the docs.json navigation structure.Parameters
includeAllFields(optional, default: false): Include all docs.json fields (theme, colors, logo, etc.)
Usage
Returns
register_nav
Register a new documentation page in the docs.json navigation config.Parameters
docPath(required): Path to the new doc file relative to docs roottitle(required): Title to display in navigationgroup(optional): Navigation group to add to (e.g. ‘Getting Started’, ‘Features’)position(optional, default: ‘end’): Where to add within the group (‘start’ or ‘end’)
Usage
update_nav
Update the docs.json navigation structure. Supports adding/removing pages, creating/modifying groups, and moving pages between groups.Parameters
action(required): The navigation update action - ‘add_page’, ‘remove_page’, ‘move_page’, ‘add_group’, ‘remove_group’, ‘update_group’, or ‘replace_all’- Additional parameters depend on the action selected
Usage examples
search_mintlify
Search Mintlify documentation for features, components, examples, and API references.Parameters
query(required): Search query to find Mintlify features, components, examples, or API references