Skip to main content

Command Line Interface

DocuMCP primarily operates as an MCP server integrated with AI assistants, but it also provides command-line utilities for direct usage and debugging.

MCP Server Usage​

The primary way to use DocuMCP is through MCP-compatible clients:

Starting the MCP Server​

# Using npx (recommended)
npx documcp

# Using global installation
documcp

# Using Node.js directly
node dist/index.js

Server Information​

# Check version
documcp --version

# Show help
documcp --help

# Debug mode
DEBUG=* documcp

MCP Client Integration​

Claude Desktop Configuration​

Add to claude_desktop_config.json:

{
  "mcpServers": {
    "documcp": {
      "command": "npx",
      "args": ["documcp"],
      "env": {
        "DOCUMCP_STORAGE_DIR": "/path/to/storage"
      }
    }
  }
}

Environment Variables​

VariableDescriptionDefault
DOCUMCP_STORAGE_DIRMemory storage directory.documcp/memory
DEBUGEnable debug loggingfalse
NODE_ENVNode.js environmentdevelopment

Development Commands​

For development and testing:

Build Commands​

# Build TypeScript
npm run build

# Build in watch mode
npm run dev

# Type checking
npm run typecheck

Testing Commands​

# Run all tests
npm test

# Run tests with coverage
npm run test:coverage

# Run performance benchmarks
npm run test:performance

# CI test run
npm run test:ci

Code Quality Commands​

# Lint code
npm run lint

# Fix linting issues
npm run lint:fix

# Format code
npm run format

# Check formatting
npm run format:check

# Full validation
npm run validate:rules

Documentation Commands​

# Check documentation links
npm run docs:check-links

# Check external links
npm run docs:check-links:external

# Check internal links only
npm run docs:check-links:internal

# Validate documentation structure
npm run docs:validate

# Complete documentation test
npm run docs:test

Security Commands​

# Check for vulnerabilities
npm run security:check

# Audit dependencies
npm audit

# Fix security issues
npm audit fix

Benchmark Commands​

# Run performance benchmarks
npm run benchmark:run

# Show current performance metrics
npm run benchmark:current

# Create benchmark configuration
npm run benchmark:create-config

# Show benchmark help
npm run benchmark:help

Tool Invocation via CLI​

While DocuMCP is designed for MCP integration, you can test tools via Node.js:

Direct Tool Testing​

// test-tool.js
import { analyzeRepository } from "./dist/tools/analyze-repository.js";

async function test() {
  const result = await analyzeRepository({
    path: process.cwd(),
    depth: "standard",
  });
  console.log(JSON.stringify(result, null, 2));
}

test().catch(console.error);
# Run test
node test-tool.js

Tool-Specific Examples​

Repository Analysis:

import { analyzeRepository } from "./dist/tools/analyze-repository.js";

const analysis = await analyzeRepository({
  path: "/path/to/repository",
  depth: "deep",
});

SSG Recommendation:

import { recommendSSG } from "./dist/tools/recommend-ssg.js";

const recommendation = await recommendSSG({
  analysisId: "analysis_12345",
  preferences: {
    ecosystem: "javascript",
    priority: "features",
  },
});

Configuration Generation:

import { generateConfig } from "./dist/tools/generate-config.js";

const config = await generateConfig({
  ssg: "docusaurus",
  projectName: "My Project",
  outputPath: "./docs",
});

Debugging​

Debug Modes​

Enable detailed logging:

# All debug info
DEBUG=* documcp

# Specific modules
DEBUG=documcp:* documcp
DEBUG=documcp:analysis documcp
DEBUG=documcp:memory documcp

Log Levels​

DocuMCP supports different log levels:

# Error only
NODE_ENV=production documcp

# Development (verbose)
NODE_ENV=development documcp

# Custom logging
DEBUG=documcp:error,documcp:warn documcp

Performance Debugging​

# Enable performance tracking
DEBUG=documcp:perf documcp

# Memory usage tracking
DEBUG=documcp:memory documcp

# Network requests
DEBUG=documcp:http documcp

Configuration Files​

Project-level Configuration​

Create .documcprc.json in your project:

{
  "storage": {
    "directory": ".documcp/memory",
    "maxEntries": 1000,
    "cleanupDays": 30
  },
  "analysis": {
    "defaultDepth": "standard",
    "excludePatterns": ["node_modules", ".git", "dist"]
  },
  "deployment": {
    "defaultBranch": "gh-pages",
    "verifyDeployment": true
  }
}

Global Configuration​

Create ~/.documcp/config.json:

{
  "defaultPreferences": {
    "ecosystem": "any",
    "priority": "simplicity"
  },
  "github": {
    "defaultOrg": "your-username"
  },
  "memory": {
    "enableLearning": true,
    "shareAnonymousData": false
  }
}

Exit Codes​

DocuMCP uses standard exit codes:

CodeMeaning
0Success
1General error
2Invalid arguments
3File system error
4Network error
5Configuration error
6Tool execution error

Scripting and Automation​

Batch Operations​

Create scripts for common workflows:

#!/bin/bash
# deploy-docs.sh

set -e

echo "Starting documentation deployment..."

# Test locally first
echo "Testing local build..."
npm run docs:validate

# Deploy via DocuMCP
echo "Analyzing repository..."
# Trigger MCP analysis through your client

echo "Deployment complete!"

CI/CD Integration​

DocuMCP can be used in CI/CD pipelines:

# .github/workflows/docs.yml
name: Documentation

on:
  push:
    branches: [main]
    paths: ["docs/**", "*.md"]

jobs:
  deploy-docs:
    runs-on: ubuntu-latest
    steps:
      - uses: actions/checkout@v4

      - name: Setup Node.js
        uses: actions/setup-node@v4
        with:
          node-version: "20"

      - name: Install DocuMCP
        run: npm install -g documcp

      - name: Validate documentation
        run: |
          # Use DocuMCP validation tools
          npm run docs:validate

Programmatic Usage​

For advanced integration:

// integration.js
import { Server } from "@modelcontextprotocol/sdk/server/index.js";
import { analyzeRepository, recommendSSG, deployPages } from "documcp";

class DocuMCPIntegration {
  async deployDocumentation(repoPath) {
    // Analyze
    const analysis = await analyzeRepository({
      path: repoPath,
      depth: "standard",
    });

    // Get recommendation
    const recommendation = await recommendSSG({
      analysisId: analysis.id,
    });

    // Deploy
    const deployment = await deployPages({
      repository: repoPath,
      ssg: recommendation.recommended,
    });

    return { analysis, recommendation, deployment };
  }
}

Troubleshooting CLI Issues​

Common Problems​

Command not found:

# Check installation
which documcp
npm list -g documcp

# Reinstall if needed
npm uninstall -g documcp
npm install -g documcp

Permission errors:

# Check permissions
ls -la $(which documcp)

# Fix permissions
chmod +x $(which documcp)

Module resolution errors:

# Clear npm cache
npm cache clean --force

# Rebuild
npm run build

Getting Help​

# Show help
documcp --help

# Show version
documcp --version

# Contact support
echo "Report issues: https://github.com/tosin2013/documcp/issues"

For more detailed troubleshooting, see the Troubleshooting Guide.