Skip to main content

API Overview

DocuMCP provides 45 specialized tools organized into functional categories for intelligent documentation deployment via the Model Context Protocol (MCP).

🎯 Quick Reference: LLM_CONTEXT.md​

For AI assistants and LLMs, reference the comprehensive context file:

File: /LLM_CONTEXT.md (in project root)

This auto-generated file provides:

  • All 45 tool descriptions with parameters
  • Usage examples and code snippets
  • Common workflow patterns
  • Memory system documentation
  • Phase 3 code-to-docs sync features

Usage in AI assistants:

@LLM_CONTEXT.md help me deploy documentation to GitHub Pages

📚 Tool Categories​

Core Documentation Tools (9 tools)​

Essential tools for repository analysis, recommendations, and deployment:

ToolPurposeKey Parameters
analyze_repositoryAnalyze project structure & dependenciespath, depth
recommend_ssgRecommend static site generatoranalysisId, preferences
generate_configGenerate SSG configuration filesssg, projectName, outputPath
setup_structureCreate Diataxis documentation structurepath, ssg
deploy_pagesDeploy to GitHub Pages with trackingrepository, ssg, userId
verify_deploymentVerify deployment statusrepository, url
populate_diataxis_contentGenerate project-specific contentanalysisId, docsPath
update_existing_documentationUpdate existing docs intelligentlyanalysisId, docsPath
validate_diataxis_contentValidate documentation qualitycontentPath, validationType

README Analysis & Generation (6 tools)​

Specialized tools for README creation and optimization:

ToolPurposeKey Parameters
evaluate_readme_healthAssess README quality & onboardingreadme_path, project_type
readme_best_practicesAnalyze against best practicesreadme_path, generate_template
generate_readme_templateCreate standardized READMEprojectName, description, templateType
validate_readme_checklistValidate against community standardsreadmePath, strict
analyze_readmeComprehensive length & structure analysisproject_path, optimization_level
optimize_readmeRestructure and condense contentreadme_path, strategy, max_length

Phase 3: Code-to-Docs Synchronization (2 tools)​

Advanced AST-based code analysis and drift detection:

ToolPurposeKey Parameters
sync_code_to_docsDetect and fix documentation driftprojectPath, docsPath, mode
generate_contextual_contentGenerate docs from code analysisfilePath, documentationType

Supported Languages: TypeScript, JavaScript, Python, Go, Rust, Java, Ruby, Bash

Drift Types Detected: Outdated, Incorrect, Missing, Breaking

Memory & Analytics Tools (2 tools)​

User preferences and deployment pattern analysis:

ToolPurposeKey Parameters
manage_preferencesManage user preferences & SSG historyaction, userId, preferences
analyze_deploymentsAnalyze deployment patterns & insightsanalysisType, ssg, periodDays

Validation & Testing Tools (4 tools)​

Quality assurance and deployment testing:

ToolPurposeKey Parameters
validate_contentValidate links, code, and referencescontentPath, validationType
check_documentation_linksComprehensive link validationdocumentation_path, check_external_links
test_local_deploymentTest build and local serverrepositoryPath, ssg, port
setup_playwright_testsGenerate E2E test infrastructurerepositoryPath, ssg, projectName

Utility Tools (3 tools)​

Additional functionality and management:

ToolPurposeKey Parameters
detect_documentation_gapsIdentify missing contentrepositoryPath, documentationPath
manage_sitemapGenerate and validate sitemap.xmlaction, docsPath, baseUrl
read_directoryList files within allowed rootspath

Advanced Memory Tools (19 tools)​

Sophisticated memory, learning, and knowledge graph operations:

Tool CategoryToolsPurpose
Memory Recallmemory_recall, memory_contextual_searchRetrieve and search memories
Intelligencememory_intelligent_analysis, memory_enhanced_recommendationAI-powered insights
Knowledge Graphmemory_knowledge_graph, memory_learning_statsGraph queries and statistics
Collaborationmemory_agent_networkMulti-agent memory sharing
Insightsmemory_insights, memory_similar, memory_temporal_analysisPattern analysis
Data Managementmemory_export, memory_cleanup, memory_pruningExport, cleanup, optimization
Visualizationmemory_visualizationVisual representations
Advanced I/Omemory_export_advanced, memory_import_advanced, memory_migrationComplex data operations
Metricsmemory_optimization_metricsPerformance analysis

🔗 Detailed Documentation​

Full API Reference​

Configuration & Usage​

Common Workflows​

1. New Documentation Site​

analyze_repository → recommend_ssg → generate_config →
setup_structure → populate_diataxis_content → deploy_pages

2. Documentation Sync (Phase 3)​

sync_code_to_docs (detect) → review drift →
sync_code_to_docs (apply) → manual review

3. Existing Docs Improvement​

analyze_repository → update_existing_documentation →
validate_diataxis_content → check_documentation_links

4. README Enhancement​

analyze_readme → evaluate_readme_health →
readme_best_practices → optimize_readme

📦 Memory Knowledge Graph​

DocuMCP includes a persistent memory system that learns from every analysis:

Entity Types​

  • Project: Software projects with analysis history
  • User: User preferences and SSG patterns
  • Configuration: SSG deployment configs with success rates
  • Documentation: Documentation structures and patterns
  • CodeFile: Source code files with change tracking
  • DocumentationSection: Docs sections linked to code
  • Technology: Languages, frameworks, and tools

Relationship Types​

  • project_uses_technology: Links projects to tech stack
  • user_prefers_ssg: Tracks user SSG preferences
  • project_deployed_with: Records deployment outcomes
  • similar_to: Identifies similar projects
  • documents: Links code files to documentation
  • outdated_for: Flags out-of-sync documentation
  • depends_on: Tracks technology dependencies

Storage Location​

  • Default: .documcp/memory/
  • Entities: .documcp/memory/knowledge-graph-entities.jsonl
  • Relationships: .documcp/memory/knowledge-graph-relationships.jsonl
  • Backups: .documcp/memory/backups/
  • Snapshots: .documcp/snapshots/ (for drift detection)

🎓 Getting Started​

  1. Start with tutorials: Getting Started Guide
  2. Learn effective prompting: Prompting Guide
  3. Reference LLM_CONTEXT.md: Use @LLM_CONTEXT.md in AI assistants
  4. Explore workflows: Common Workflows

📊 Tool Statistics​

  • Total Tools: 45
  • Core Documentation: 9 tools
  • README Management: 6 tools
  • Phase 3 Sync: 2 tools
  • Memory & Analytics: 2 tools
  • Validation: 4 tools
  • Utilities: 3 tools
  • Advanced Memory: 19 tools

🔍 Search & Discovery​

Documentation auto-generated from DocuMCP v0.3.2