Design Engineer Logo
Visit Repo
Open Graph preview

MCP-RTFM

MCP-RTFM helps you CREATE the F*ing Manual that people keep telling everyone to read

Site favicon
🔄 paraDX

Overview

MCP-RTFM

Transform your documentation chaos into clarity with MCP-RTFM - because the best way to handle "RTFM" is to have an FM worth reading! This MCP server employs advanced content analysis and intelligent search to create documentation that actually answers questions before they're asked.

Core Capabilities

Smart Documentation Management

  • Automated content analysis and metadata generation
  • Intelligent search with context-aware results
  • Documentation relationship mapping
  • Git-aware version tracking

Built-in Intelligence

  • AST-based content analysis using unified/remark
  • Fuzzy search powered by minisearch
  • Automatic categorization and tagging
  • Smart template system

Quick Implementation

await use_mcp_tool({
  server: "mcp-rtfm",
  tool: "analyze_project_with_metadata",
  args: { projectPath: "/path/to/project" }
});

Documentation Structure

The server automatically manages core documentation:

  • Technical stack details
  • Codebase architecture
  • Workflow procedures
  • Integration guidelines
  • Error handling protocols
  • Handoff documentation

Advanced Features

Content Intelligence

  • Automatic relationship discovery
  • Smart metadata generation
  • Template inheritance
  • Real-time search indexing

Development Tools

  • Built-in debugging support
  • Custom template creation
  • Metadata-driven organization
  • Enhanced content analysis

Integration

{
  "mcpServers": {
    "mcp-rtfm": {
      "command": "node",
      "args": ["<path-to-mcp-rtfm>/build/index.js"],
      "disabled": false,
      "alwaysAllow": []
    }
  }
}

MIT Licensed - Making documentation worth reading since 2024.