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 F*ing 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 f*ing 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
Features
Documentation Management Tools
analyze_existing_docs- Analyze and enhance existing documentation with content analysis and metadata
analyze_project_with_metadata- Initialize documentation structure with enhanced content analysis and metadata generation
analyze_project- Basic initialization of documentation structure
read_doc- Read a documentation file (required before updating)
update_doc- Update documentation using diff-based changes
get_doc_content- Get current content of a documentation file
get_project_info- Get project structure and documentation status
search_docs- Search across documentation files with highlighted results
update_metadata- Update documentation metadata
get_related_docs- Find related documentation based on metadata and content links
customize_template- 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
handoff_notes.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
customize_template tool.Example Workflows
1. Analyzing Existing Documentation
2. Enhanced Project Documentation Setup
3. Updating Documentation with Content Links
4. Managing Documentation Metadata
5. Searching Documentation with Context
6. Creating Custom Templates
Installation
VSCode (Roo Cline)
Add to settings file at:
Add to settings file at:
- Windows:
%APPDATA%\Code\User\globalStorage\rooveterinaryinc.roo-cline\settings\cline_mcp_settings.json
- MacOS:
~/Library/Application Support/Code/User/globalStorage/rooveterinaryinc.roo-cline/settings/cline_mcp_settings.json
- Linux:
~/.config/Code/User/globalStorage/rooveterinaryinc.roo-cline/settings/cline_mcp_settings.json
Claude Desktop
Add to config file at:
- Windows:
%APPDATA%\Claude\claude_desktop_config.json
- MacOS:
~/Library/Application Support/Claude/claude_desktop_config.json
- Linux:
~/.config/Claude/claude_desktop_config.json
Advanced Features
Content Linking
Use
[[document-name]] syntax to create links between documents. The server automatically tracks these relationships and includes them when finding related documentation.Metadata-Driven Organization
Documents are organized using:
- Categories (e.g., "architecture", "api", "workflow")
- Tags for flexible grouping
- Automatic relationship discovery based on shared metadata
- Content link analysis
Enhanced Content Analysis
The server uses advanced libraries for better documentation management:
- unified/remark for Markdown processing:
- minisearch for powerful search capabilities:
Intelligent Metadata Generation
- Automatic content analysis for categorization
- Smart tag generation based on content patterns
- Structured front matter in documents
- AST-based title and section detection
- Code snippet identification and tagging
- Context-aware result presentation
Template System
- Built-in templates for common documentation types
- Custom template support with metadata defaults
- Template inheritance and override capabilities
- Placeholder system for consistent formatting
Development
Debugging
Since MCP servers communicate over stdio, debugging can be challenging. Use the MCP Inspector:
The Inspector will provide a URL to access debugging tools in your browser.
License
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 F*ing 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 f*ing 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
Features
Documentation Management Tools
analyze_existing_docs- Analyze and enhance existing documentation with content analysis and metadata
analyze_project_with_metadata- Initialize documentation structure with enhanced content analysis and metadata generation
analyze_project- Basic initialization of documentation structure
read_doc- Read a documentation file (required before updating)
update_doc- Update documentation using diff-based changes
get_doc_content- Get current content of a documentation file
get_project_info- Get project structure and documentation status
search_docs- Search across documentation files with highlighted results
update_metadata- Update documentation metadata
get_related_docs- Find related documentation based on metadata and content links
customize_template- 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
handoff_notes.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
customize_template tool.Example Workflows
1. Analyzing Existing Documentation
2. Enhanced Project Documentation Setup
3. Updating Documentation with Content Links
4. Managing Documentation Metadata
5. Searching Documentation with Context
6. Creating Custom Templates
Installation
VSCode (Roo Cline)
Add to settings file at:
Add to settings file at:
- Windows:
%APPDATA%\Code\User\globalStorage\rooveterinaryinc.roo-cline\settings\cline_mcp_settings.json
- MacOS:
~/Library/Application Support/Code/User/globalStorage/rooveterinaryinc.roo-cline/settings/cline_mcp_settings.json
- Linux:
~/.config/Code/User/globalStorage/rooveterinaryinc.roo-cline/settings/cline_mcp_settings.json
Claude Desktop
Add to config file at:
- Windows:
%APPDATA%\Claude\claude_desktop_config.json
- MacOS:
~/Library/Application Support/Claude/claude_desktop_config.json
- Linux:
~/.config/Claude/claude_desktop_config.json
Advanced Features
Content Linking
Use
[[document-name]] syntax to create links between documents. The server automatically tracks these relationships and includes them when finding related documentation.Metadata-Driven Organization
Documents are organized using:
- Categories (e.g., "architecture", "api", "workflow")
- Tags for flexible grouping
- Automatic relationship discovery based on shared metadata
- Content link analysis
Enhanced Content Analysis
The server uses advanced libraries for better documentation management:
- unified/remark for Markdown processing:
- minisearch for powerful search capabilities:
Intelligent Metadata Generation
- Automatic content analysis for categorization
- Smart tag generation based on content patterns
- Structured front matter in documents
- AST-based title and section detection
- Code snippet identification and tagging
- Context-aware result presentation
Template System
- Built-in templates for common documentation types
- Custom template support with metadata defaults
- Template inheritance and override capabilities
- Placeholder system for consistent formatting
Development
Debugging
Since MCP servers communicate over stdio, debugging can be challenging. Use the MCP Inspector:
The Inspector will provide a URL to access debugging tools in your browser.