ryanjoachim/mcp-rtfm

> "RTFM!" they say, but what if there's no FM to R? 🤔 Enter MCP-RTFM: an MCP server that helps you create the Fing Manual everyone keeps telling people to read! Using advanced content analysis, metadata generation, and intelligent search capabilities, it transforms your non-existent or unreadable docs into an interconnected knowledge base that actually answers those "basic questions" before they're asked.
> Plot twist: Instead of just telling people to RTFM, now you can actually give them an FM worth R-ing! Because the best response to "read the fing manual" is having a manual that's actually worth reading. 📚✨
## 📚 Table of Contents
Quick Start
Features
Example Workflows
Installation
Advanced Features
Development
Debugging
## 🚀 Quick Start
bash
# Install dependencies
npm install
# Build the server
npm run build
# Add to your MCP settings and start using
await usemcptool({
server: "mcp-rtfm",
tool: "analyzeprojectwithmetadata", // Enhanced initialization
args: { projectPath: "/path/to/project" }
});
// This will:
// 1. Create documentation structure
// 2. Analyze content with unified/remark
// 3. Generate intelligent metadata
// 4. Build search index with minisearch
// 5. Add structured front matter
// 6. Make your docs actually readable!
## ✨ Features
### Documentation Management Tools
analyzeexistingdocs - Analyze and enhance existing documentation with content analysis and metadata
analyzeprojectwithmetadata - Initialize documentation structure with enhanced content analysis and metadata generation
analyzeproject - Basic initialization of documentation structure
readdoc - Read a documentation file (required before updating)
updatedoc - Update documentation using diff-based changes
getdoccontent - Get current content of a documentation file
getprojectinfo - Get project structure and documentation status
searchdocs - Search across documentation files with highlighted results
updatemetadata - Update documentation metadata
getrelateddocs - Find related documentation based on metadata and content links
customizetemplate - Create or update documentation templates
### Default Documentation Files
The server automatically creates and manages these core documentation files:
techStack.md - Detailed inventory of tools, libraries, and configurations
codebaseDetails.md - Low-level explanations of code structure and logic
workflowDetails.md - Step-by-step workflows for key processes
integrationGuides.md - Instructions for external system connections
errorHandling.md - Troubleshooting strategies and practices
handoffnotes.md - Summary of key themes and next steps
### Documentation Templates
Built-in templates for different documentation types:
Standard Documentation Template
API Documentation Template
Workflow Documentation Template
Custom templates can be created using the customizetemplate tool.
## 📝 Example Workflows
### 1. Analyzing Existing Documentation
typescript
// Enhance existing documentation with advanced analysis
await usemcptool({
server: "mcp-rtfm",
tool: "analyzeexistingdocs",
args: { projectPath: "/path/to/project" }
});
// This will:
// - Find all markdown files in .handoffdocs
// - Analyze content structure with unified/remark