mcp-rtfm
About
Transform your non-existent or unreadable docs into an intelligent, searchable knowledge base that actually answers those 'basic questions' before they're asked.
Details
- Author
- ryanjoachim
- Repository
- ryanjoachim/mcp-rtfm
- GitHub stars
- 33
- Downloads
- 1
- Categories
- AI, Search
Jump to
Setting up with Highlight
Follow these steps to add this server as a custom Highlight plugin:
- Download and install Highlight from highlightai.com/download
- Navigate to the plugins tab and select "Add Custom Plugin"
-
Configure the plugin with the settings below
Plugin Name
mcp-rtfmCommand (node, npx, python, etc.)nodeArguments-
Argument 1
<path-to-mcp-rtfm>/build/index.js
Please refer to the README for specific instructions on how to obtain API keys or other required environment variables.
-
Argument 1
- Enable "Start Automatically" if you want the plugin to start when Highlight launches
From the repository
npm install
// Initialize documentation with advanced content analysis
await use_mcp_tool({
server: "mcp-rtfm",
tool: "analyze_project_with_metadata",
args: { projectPath: "/path/to/project" }
});
// Results include:
// - Initialized documentation files
// - Generated metadata from content analysis
// - Established document relationships
// - Populated search index
// - Added structured front matter
// - Git repository context
// Get enhanced project information
const projectInfo = await use_mcp_tool({
server: "mcp-rtfm",
tool: "get_project_info",
args: { projectPath: "/path/to/project" }
});
// Search across documentation with intelligent results
const searchResults = await use_mcp_tool({
server: "mcp-rtfm",
tool: "search_docs",
args: {
projectPath: "/path/to/project",
query: "authentication"
}
});
// Results include:
// - Weighted matches (title matches prioritized)
// - Fuzzy search results
// - Full content context
// - Related document suggestions
```
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.
Claude Desktop / Cursor
Paste into your MCP client config file to install this server.
{
"mcpServers": {
"mcp-rtfm": {
"cwd": "string (optional)",
"env": {},
"args": [
"<path-to-mcp-rtfm>/build/index.js"
],
"shell": false,
"command": "node"
}
}
}Linux
{
"cwd": "string (optional)",
"env": [],
"args": [
"<path-to-mcp-rtfm>/build/index.js"
],
"shell": false,
"command": "node"
}Macos
{
"cwd": "string (optional)",
"env": [],
"args": [
"<path-to-mcp-rtfm>/build/index.js"
],
"shell": false,
"command": "node"
}Windows
{
"cwd": "string (optional)",
"env": [],
"args": [
"<path-to-mcp-rtfm>/build/index.js"
],
"shell": false,
"command": "node"
}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
Sign in to leave a review
Use Google, GitHub, or an email account so ratings stay tied to real people.
No reviews posted yet.
