Skip to main content

Reference Documentation

Complete technical reference for DocuMCP's API, configuration, and tools.

API Reference​

Quick Reference​

Essential Tools​

# Repository Analysis
"analyze my repository with deep analysis"

# SSG Recommendation
"recommend static site generator for my project"

# Documentation Generation
"generate documentation structure for my project"

# Deployment
"deploy my documentation to GitHub Pages"

Configuration Examples​

# Basic configuration
memory:
  storage_path: ".documcp/memory"
  retention_policy: "keep_all"

deployment:
  platform: "github-pages"
  branch: "gh-pages"
  domain: "docs.example.com"

API Overview​

DocuMCP provides 21 tools across 4 main categories:

Analysis Tools​

  • analyze_repository - Comprehensive repository analysis
  • detect_gaps - Documentation gap detection
  • evaluate_readme_health - README quality assessment

Recommendation Tools​

  • recommend_ssg - Static site generator recommendations
  • generate_config - SSG configuration generation
  • setup_structure - Documentation structure creation

Content Tools​

  • populate_content - Intelligent content population
  • validate_content - Content validation and checking
  • update_existing_documentation - Documentation updates

Deployment Tools​

  • deploy_pages - GitHub Pages deployment
  • verify_deployment - Deployment verification
  • test_local_deployment - Local testing

Memory System​

DocuMCP includes a sophisticated memory system for learning and optimization:

Memory Operations​

  • memory_recall - Retrieve stored memories
  • memory_export - Export memories for backup
  • memory_import - Import memories from files
  • memory_cleanup - Clean up old memories

Analytics​

  • analyze_deployments - Deployment pattern analysis
  • memory_insights - Memory-based insights
  • similar_projects - Find similar projects

Getting Started​

  1. First Time: Start with Getting Started Tutorial
  2. API Reference: Explore MCP Tools API
  3. Configuration: Review Configuration Options
  4. Advanced Usage: Check CLI Commands

Support​