index.html•29.1 kB
<!DOCTYPE html>
<html lang="en">
<head>
<meta charset="UTF-8">
<meta name="viewport" content="width=device-width, initial-scale=1.0">
<title>docs-mcp - MCP Tool Reference</title>
<style>
* {
margin: 0;
padding: 0;
box-sizing: border-box;
}
body {
font-family: -apple-system, BlinkMacSystemFont, 'Segoe UI', Roboto, Oxygen, Ubuntu, Cantarell, sans-serif;
background: #0d1117;
color: #c9d1d9;
line-height: 1.6;
padding: 20px;
}
.container {
max-width: 1200px;
margin: 0 auto;
}
header {
text-align: center;
margin-bottom: 40px;
padding-bottom: 20px;
border-bottom: 2px solid #21262d;
}
h1 {
color: #58a6ff;
font-size: 2.5em;
margin-bottom: 10px;
}
.subtitle {
color: #8b949e;
font-size: 1.1em;
}
.version {
display: inline-block;
background: #1f6feb;
color: white;
padding: 4px 12px;
border-radius: 20px;
font-size: 0.85em;
margin-top: 10px;
}
.server-config {
background: #161b22;
border: 1px solid #30363d;
border-radius: 8px;
padding: 20px;
margin-bottom: 30px;
}
.server-config h2 {
color: #58a6ff;
margin-bottom: 15px;
font-size: 1.3em;
}
.config-block {
position: relative;
}
.tool-card {
background: #161b22;
border: 1px solid #30363d;
border-radius: 8px;
padding: 20px;
margin-bottom: 20px;
transition: border-color 0.2s;
}
.tool-card:hover {
border-color: #58a6ff;
}
.tool-header {
display: flex;
justify-content: space-between;
align-items: start;
margin-bottom: 15px;
}
.tool-name {
color: #58a6ff;
font-size: 1.4em;
font-weight: 600;
}
.tool-category {
background: #21262d;
color: #8b949e;
padding: 4px 10px;
border-radius: 4px;
font-size: 0.85em;
text-transform: uppercase;
}
.tool-description {
color: #8b949e;
margin-bottom: 15px;
line-height: 1.5;
}
pre {
background: #0d1117;
border: 1px solid #30363d;
border-radius: 6px;
padding: 16px;
overflow-x: auto;
font-family: 'Courier New', monospace;
font-size: 0.9em;
position: relative;
}
code {
color: #79c0ff;
}
.copy-btn {
position: absolute;
top: 10px;
right: 10px;
background: #21262d;
border: 1px solid #30363d;
color: #c9d1d9;
padding: 6px 12px;
border-radius: 6px;
cursor: pointer;
font-size: 0.85em;
transition: all 0.2s;
}
.copy-btn:hover {
background: #30363d;
border-color: #58a6ff;
}
.copy-btn.copied {
background: #238636;
border-color: #2ea043;
color: white;
}
.required {
color: #f85149;
font-weight: bold;
}
.optional {
color: #8b949e;
font-style: italic;
}
.tool-section {
margin-bottom: 40px;
}
.section-title {
color: #f0883e;
font-size: 1.8em;
margin-bottom: 20px;
padding-bottom: 10px;
border-bottom: 2px solid #21262d;
}
.note {
background: #1f2937;
border-left: 4px solid #f0883e;
padding: 12px 16px;
margin: 15px 0;
border-radius: 4px;
}
.note-title {
color: #f0883e;
font-weight: 600;
margin-bottom: 5px;
}
footer {
text-align: center;
margin-top: 60px;
padding-top: 20px;
border-top: 2px solid #21262d;
color: #8b949e;
}
</style>
</head>
<body>
<div class="container">
<header>
<h1>📚 docs-mcp</h1>
<p class="subtitle">Documentation Generation MCP Server • 23 MCP Tools</p>
<span class="version">v2.0.0</span>
</header>
<!-- Server Configuration -->
<div class="server-config">
<h2>🔧 MCP Server Configuration</h2>
<p class="tool-description">Add this to your Claude Desktop config.json (mcpServers section):</p>
<div class="config-block">
<button class="copy-btn" onclick="copyToClipboard(this, 'server-config')">Copy</button>
<pre><code id="server-config">{
"docs-mcp": {
"command": "python",
"args": ["<path-to-docs-mcp>/server.py"]
}
}</code></pre>
</div>
<div class="note">
<div class="note-title">⚠️ Path Note</div>
Replace <path-to-docs-mcp> with your installation directory.<br>
<strong>Windows example:</strong> "C:\\Users\\username\\.mcp-servers\\docs-mcp\\server.py"<br>
<strong>Unix/Mac example:</strong> "/Users/username/.mcp-servers/docs-mcp/server.py"
</div>
</div>
<!-- Documentation Tools -->
<div class="tool-section">
<h2 class="section-title">📝 Documentation Generation Tools</h2>
<div class="tool-card">
<div class="tool-header">
<span class="tool-name">list_templates</span>
<span class="tool-category">Documentation</span>
</div>
<p class="tool-description">Lists all available POWER framework documentation templates (README, ARCHITECTURE, API, COMPONENTS, SCHEMA, USER-GUIDE)</p>
<button class="copy-btn" onclick="copyToClipboard(this, 'list-templates')">Copy</button>
<pre><code id="list-templates">{
"name": "list_templates",
"arguments": {}
}</code></pre>
</div>
<div class="tool-card">
<div class="tool-header">
<span class="tool-name">get_template</span>
<span class="tool-category">Documentation</span>
</div>
<p class="tool-description">Retrieves the content of a specific documentation template</p>
<button class="copy-btn" onclick="copyToClipboard(this, 'get-template')">Copy</button>
<pre><code id="get-template">{
"name": "get_template",
"arguments": {
"template_name": "readme"
}
}</code></pre>
<div class="note">
<div class="note-title">Template Options</div>
readme | architecture | api | components | schema | user-guide
</div>
</div>
<div class="tool-card">
<div class="tool-header">
<span class="tool-name">generate_foundation_docs</span>
<span class="tool-category">Documentation</span>
</div>
<p class="tool-description">Generate all foundation documentation files. Returns templates and generation plan - Claude generates and saves the actual documents.</p>
<button class="copy-btn" onclick="copyToClipboard(this, 'gen-foundation')">Copy</button>
<pre><code id="gen-foundation">{
"name": "generate_foundation_docs",
"arguments": {
"project_path": "<project-path>"
}
}</code></pre>
</div>
<div class="tool-card">
<div class="tool-header">
<span class="tool-name">generate_individual_doc</span>
<span class="tool-category">Documentation</span>
</div>
<p class="tool-description">Generate a single documentation file. Returns the template - Claude generates and saves the document.</p>
<button class="copy-btn" onclick="copyToClipboard(this, 'gen-individual')">Copy</button>
<pre><code id="gen-individual">{
"name": "generate_individual_doc",
"arguments": {
"project_path": "<project-path>",
"template_name": "readme"
}
}</code></pre>
</div>
<div class="tool-card">
<div class="tool-header">
<span class="tool-name">generate_quickref_interactive</span>
<span class="tool-category">Documentation</span>
</div>
<p class="tool-description">Generate universal quickref guide for ANY application via interactive interview. AI asks 9 questions, user answers in plain English, generates scannable quickref.md (150-250 lines).</p>
<button class="copy-btn" onclick="copyToClipboard(this, 'gen-quickref')">Copy</button>
<pre><code id="gen-quickref">{
"name": "generate_quickref_interactive",
"arguments": {
"project_path": "<project-path>",
"app_type": "cli"
}
}</code></pre>
<div class="note">
<div class="note-title">App Types (Optional)</div>
cli | web | api | desktop | library
</div>
</div>
</div>
<!-- Changelog Tools -->
<div class="tool-section">
<h2 class="section-title">📋 Changelog Management Tools</h2>
<div class="tool-card">
<div class="tool-header">
<span class="tool-name">get_changelog</span>
<span class="tool-category">Changelog</span>
</div>
<p class="tool-description">Get project changelog with structured change history. Supports filtering by version, change type, or breaking changes.</p>
<button class="copy-btn" onclick="copyToClipboard(this, 'get-changelog')">Copy</button>
<pre><code id="get-changelog">{
"name": "get_changelog",
"arguments": {
"project_path": "<project-path>",
"version": "1.0.7",
"change_type": "enhancement",
"breaking_only": false
}
}</code></pre>
<div class="note">
<div class="note-title">Optional Filters</div>
<strong>change_type:</strong> bugfix | enhancement | feature | breaking_change | deprecation | security<br>
<strong>breaking_only:</strong> true/false<br>
<strong>version:</strong> specific version (e.g., "1.0.7")
</div>
</div>
<div class="tool-card">
<div class="tool-header">
<span class="tool-name">add_changelog_entry</span>
<span class="tool-category">Changelog</span>
</div>
<p class="tool-description"><strong>⚠️ Use this tool to update changelogs, NOT direct Python code!</strong> Add a new entry with full change details.</p>
<button class="copy-btn" onclick="copyToClipboard(this, 'add-changelog')">Copy</button>
<pre><code id="add-changelog">{
"name": "add_changelog_entry",
"arguments": {
"project_path": "<project-path>",
"version": "1.0.10",
"change_type": "enhancement",
"severity": "major",
"title": "Short title of the change",
"description": "Detailed description of what changed",
"files": ["file1.py", "file2.py"],
"reason": "Why this change was made",
"impact": "Impact on users/system",
"breaking": false,
"migration": "Migration guide (if breaking)",
"summary": "Version summary (for new versions)",
"contributors": ["Your Name"]
}
}</code></pre>
<div class="note">
<div class="note-title">Required Fields</div>
<span class="required">*</span> project_path, version, change_type, severity, title, description, files, reason, impact
</div>
<div class="note">
<div class="note-title">Enums</div>
<strong>change_type:</strong> bugfix | enhancement | feature | breaking_change | deprecation | security<br>
<strong>severity:</strong> critical | major | minor | patch
</div>
</div>
<div class="tool-card">
<div class="tool-header">
<span class="tool-name">update_changelog</span>
<span class="tool-category">Changelog</span>
</div>
<p class="tool-description">Meta-tool that instructs the agent to analyze recent changes and call add_changelog_entry. Enables self-documenting agentic workflows.</p>
<button class="copy-btn" onclick="copyToClipboard(this, 'update-changelog')">Copy</button>
<pre><code id="update-changelog">{
"name": "update_changelog",
"arguments": {
"project_path": "<project-path>",
"version": "1.0.10"
}
}</code></pre>
</div>
</div>
<!-- Consistency Management Tools -->
<div class="tool-section">
<h2 class="section-title">🔍 Consistency Management Tools</h2>
<div class="tool-card">
<div class="tool-header">
<span class="tool-name">establish_standards</span>
<span class="tool-category">Consistency</span>
</div>
<p class="tool-description">Scan codebase to discover UI/UX/behavior patterns and generate standards documentation. Creates 4 markdown files in coderef/standards/. Run ONCE per project to establish baseline standards.</p>
<button class="copy-btn" onclick="copyToClipboard(this, 'establish-standards')">Copy</button>
<pre><code id="establish-standards">{
"name": "establish_standards",
"arguments": {
"project_path": "<project-path>",
"scan_depth": "standard",
"focus_areas": ["all"]
}
}</code></pre>
<div class="note">
<div class="note-title">Optional Parameters</div>
<strong>scan_depth:</strong> quick | standard | deep<br>
<strong>focus_areas:</strong> ui_components | behavior_patterns | ux_flows | all
</div>
</div>
<div class="tool-card">
<div class="tool-header">
<span class="tool-name">audit_codebase</span>
<span class="tool-category">Consistency</span>
</div>
<p class="tool-description">Audit codebase for standards violations using established standards documents. Scans all source files, compares against standards, and generates comprehensive compliance report with violations, severity levels, and fix suggestions.</p>
<button class="copy-btn" onclick="copyToClipboard(this, 'audit-codebase')">Copy</button>
<pre><code id="audit-codebase">{
"name": "audit_codebase",
"arguments": {
"project_path": "<project-path>",
"standards_dir": "coderef/standards",
"severity_filter": "all",
"scope": ["all"],
"generate_fixes": true
}
}</code></pre>
<div class="note">
<div class="note-title">Optional Parameters</div>
<strong>severity_filter:</strong> critical | major | minor | all<br>
<strong>scope:</strong> ui_patterns | behavior_patterns | ux_patterns | all<br>
<strong>generate_fixes:</strong> true | false
</div>
</div>
<div class="tool-card">
<div class="tool-header">
<span class="tool-name">check_consistency</span>
<span class="tool-category">Consistency</span>
</div>
<p class="tool-description">Lightweight pre-commit consistency checker. Auto-detects git changes (staged files) and checks only modified files for standards violations. Perfect for CI/CD pipelines and pre-commit hooks.</p>
<button class="copy-btn" onclick="copyToClipboard(this, 'check-consistency')">Copy</button>
<pre><code id="check-consistency">{
"name": "check_consistency",
"arguments": {
"project_path": "<project-path>",
"files": ["src/Button.tsx", "src/Modal.tsx"],
"scope": ["all"],
"severity_threshold": "major",
"fail_on_violations": true
}
}</code></pre>
<div class="note">
<div class="note-title">Optional Parameters</div>
<strong>files:</strong> List of files to check (auto-detects git changes if omitted)<br>
<strong>severity_threshold:</strong> critical | major | minor<br>
<strong>fail_on_violations:</strong> Return error status if violations found (default: true)
</div>
</div>
</div>
<!-- Planning Workflow Tools -->
<div class="tool-section">
<h2 class="section-title">📋 Planning Workflow Tools</h2>
<div class="tool-card">
<div class="tool-header">
<span class="tool-name">get_planning_template</span>
<span class="tool-category">Planning</span>
</div>
<p class="tool-description">Returns feature implementation planning template or specific sections for AI reference during plan creation.</p>
<button class="copy-btn" onclick="copyToClipboard(this, 'get-planning-template')">Copy</button>
<pre><code id="get-planning-template">{
"name": "get_planning_template",
"arguments": {
"section": "all"
}
}</code></pre>
<div class="note">
<div class="note-title">Section Options</div>
all | 0_preparation | 1_executive_summary | 2_risk_assessment | 3_current_state_analysis | 4_key_features | 5_task_id_system | 6_implementation_phases | 7_testing_strategy | 8_success_criteria | 9_implementation_checklist
</div>
</div>
<div class="tool-card">
<div class="tool-header">
<span class="tool-name">analyze_project_for_planning</span>
<span class="tool-category">Planning</span>
</div>
<p class="tool-description">Analyzes project to discover foundation docs, coding standards, reference components, and patterns. Automates section 0 (Preparation) of planning template. Run before creating implementation plans.</p>
<button class="copy-btn" onclick="copyToClipboard(this, 'analyze-project')">Copy</button>
<pre><code id="analyze-project">{
"name": "analyze_project_for_planning",
"arguments": {
"project_path": "<project-path>"
}
}</code></pre>
</div>
<div class="tool-card">
<div class="tool-header">
<span class="tool-name">create_plan</span>
<span class="tool-category">Planning</span>
</div>
<p class="tool-description">Create implementation plan by synthesizing context, analysis, and template. Loads context.json (from /gather-context), project analysis (from /analyze-for-planning), and AI-optimized template. Generates complete 10-section plan in batch mode with auto-retry.</p>
<button class="copy-btn" onclick="copyToClipboard(this, 'create-plan')">Copy</button>
<pre><code id="create-plan">{
"name": "create_plan",
"arguments": {
"project_path": "<project-path>",
"feature_name": "auth-system"
}
}</code></pre>
<div class="note">
<div class="note-title">Feature Name Requirements</div>
Alphanumeric, hyphens, and underscores only. Max 100 characters.
</div>
</div>
<div class="tool-card">
<div class="tool-header">
<span class="tool-name">validate_implementation_plan</span>
<span class="tool-category">Planning</span>
</div>
<p class="tool-description">Validates implementation plan JSON against quality checklist. Scores 0-100 and identifies issues by severity. Enables iterative review loops until plan quality reaches threshold (≥90 recommended).</p>
<button class="copy-btn" onclick="copyToClipboard(this, 'validate-plan')">Copy</button>
<pre><code id="validate-plan">{
"name": "validate_implementation_plan",
"arguments": {
"project_path": "<project-path>",
"plan_file_path": "feature-auth-plan.json"
}
}</code></pre>
</div>
<div class="tool-card">
<div class="tool-header">
<span class="tool-name">generate_plan_review_report</span>
<span class="tool-category">Planning</span>
</div>
<p class="tool-description">Generates markdown review report from validation results. Formats score, issues by severity, and actionable recommendations into user-friendly report.</p>
<button class="copy-btn" onclick="copyToClipboard(this, 'generate-review-report')">Copy</button>
<pre><code id="generate-review-report">{
"name": "generate_plan_review_report",
"arguments": {
"project_path": "<project-path>",
"plan_file_path": "feature-auth-plan.json",
"output_path": "review-report.md"
}
}</code></pre>
</div>
</div>
<!-- Project Inventory Tools -->
<div class="tool-section">
<h2 class="section-title">📦 Project Inventory Tools</h2>
<div class="tool-card">
<div class="tool-header">
<span class="tool-name">inventory_manifest</span>
<span class="tool-category">Inventory</span>
</div>
<p class="tool-description">Generate comprehensive file inventory with metadata, categories, risk levels, and dependency analysis. Perfect for project audits and understanding codebase structure.</p>
<button class="copy-btn" onclick="copyToClipboard(this, 'inventory-manifest')">Copy</button>
<pre><code id="inventory-manifest">{
"name": "inventory_manifest",
"arguments": {
"project_path": "<project-path>",
"analysis_depth": "standard"
}
}</code></pre>
</div>
<div class="tool-card">
<div class="tool-header">
<span class="tool-name">dependency_inventory</span>
<span class="tool-category">Inventory</span>
</div>
<p class="tool-description">Analyze project dependencies across multiple ecosystems (npm, pip, cargo, composer) with security vulnerability scanning via OSV API. Detects outdated packages and licenses.</p>
<button class="copy-btn" onclick="copyToClipboard(this, 'dependency-inventory')">Copy</button>
<pre><code id="dependency-inventory">{
"name": "dependency_inventory",
"arguments": {
"project_path": "<project-path>",
"ecosystems": ["all"],
"scan_security": true
}
}</code></pre>
</div>
<div class="tool-card">
<div class="tool-header">
<span class="tool-name">api_inventory</span>
<span class="tool-category">Inventory</span>
</div>
<p class="tool-description">Discover and catalog API endpoints across frameworks (FastAPI, Flask, Express, GraphQL). Analyzes request/response schemas and documentation coverage. Saves to api.json manifest.</p>
<button class="copy-btn" onclick="copyToClipboard(this, 'api-inventory')">Copy</button>
<pre><code id="api-inventory">{
"name": "api_inventory",
"arguments": {
"project_path": "<project-path>",
"frameworks": ["all"],
"scan_documentation": true
}
}</code></pre>
</div>
<div class="tool-card">
<div class="tool-header">
<span class="tool-name">database_inventory</span>
<span class="tool-category">Inventory</span>
</div>
<p class="tool-description">Discover database schemas across PostgreSQL, MySQL, MongoDB, SQLite. Parses ORM models (SQLAlchemy, Sequelize, Mongoose) and migration files (Alembic, Knex). Extracts relationships and indexes.</p>
<button class="copy-btn" onclick="copyToClipboard(this, 'database-inventory')">Copy</button>
<pre><code id="database-inventory">{
"name": "database_inventory",
"arguments": {
"project_path": "<project-path>",
"database_systems": ["all"],
"include_migrations": true
}
}</code></pre>
</div>
<div class="tool-card">
<div class="tool-header">
<span class="tool-name">config_inventory</span>
<span class="tool-category">Inventory</span>
</div>
<p class="tool-description">Discover and analyze configuration files (JSON, YAML, TOML, INI, ENV) with security masking. Detects API keys, passwords, tokens and rates security. Perfect for pre-commit scanning.</p>
<button class="copy-btn" onclick="copyToClipboard(this, 'config-inventory')">Copy</button>
<pre><code id="config-inventory">{
"name": "config_inventory",
"arguments": {
"project_path": "<project-path>",
"formats": ["all"],
"mask_sensitive": true
}
}</code></pre>
</div>
<div class="tool-card">
<div class="tool-header">
<span class="tool-name">test_inventory</span>
<span class="tool-category">Inventory</span>
</div>
<p class="tool-description">Discover test files and frameworks (pytest, unittest, jest, mocha, rspec). Analyzes coverage metrics (statements, branches, functions, lines). Identifies untested code and calculates readiness score.</p>
<button class="copy-btn" onclick="copyToClipboard(this, 'test-inventory')">Copy</button>
<pre><code id="test-inventory">{
"name": "test_inventory",
"arguments": {
"project_path": "<project-path>",
"frameworks": ["all"],
"include_coverage": true
}
}</code></pre>
</div>
<div class="tool-card">
<div class="tool-header">
<span class="tool-name">documentation_inventory</span>
<span class="tool-category">Inventory</span>
</div>
<p class="tool-description">Discover and analyze documentation files across 5 formats (Markdown, RST, AsciiDoc, HTML, Org-mode). Calculates quality metrics (freshness, completeness, coverage). Generates quality score (0-100).</p>
<button class="copy-btn" onclick="copyToClipboard(this, 'documentation-inventory')">Copy</button>
<pre><code id="documentation-inventory">{
"name": "documentation_inventory",
"arguments": {
"project_path": "<project-path>"
}
}</code></pre>
</div>
</div>
<footer>
<p><strong>docs-mcp</strong> v2.0.0 | MCP Protocol 1.0 | Python 3.11+</p>
<p style="margin-top: 10px;">Maintainers: willh, Claude Code AI</p>
</footer>
</div>
<script>
function copyToClipboard(button, elementId) {
const code = document.getElementById(elementId).textContent;
navigator.clipboard.writeText(code).then(() => {
const originalText = button.textContent;
button.textContent = '✓ Copied!';
button.classList.add('copied');
setTimeout(() => {
button.textContent = originalText;
button.classList.remove('copied');
}, 2000);
}).catch(err => {
console.error('Failed to copy:', err);
button.textContent = '✗ Failed';
setTimeout(() => {
button.textContent = 'Copy';
}, 2000);
});
}
</script>
</body>
</html>