MCP RTFM Server

Ever been told to RTFM only to find there is no FM to R? MCP-RTFM helps you CREATE the F*ing Manual that people keep telling everyone to read! Transform your non-existent or unreadable docs into an intelligent, searchable knowledge base that actually answers those 'basic questions' before they're asked.

javascript

GitHub Stars

javascript

Language

6 months ago

First Indexed

2 months ago

Catalog Refreshed

Documentation & install

Readme and setup notes from the catalogue, plus a client-ready config you can copy for your MCP host.

Installation

Add the following to your MCP client configuration file.

Configuration

View docs

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

You deploy MCP-RTFM to automatically generate and organize documentation by analyzing content, generating metadata, and building a searchable knowledge base. This server helps you create readable, interlinked docs that answer questions before they’re asked, making your project documentation fast to navigate and easy to maintain.

How to use

You connect an MCP client to the MCP-RTFM server to initialize and manage your documentation. Use the enhanced tools to analyze project content, generate metadata, and build a searchable index. You can initialize documentation, read and update files, search for relevant topics, and discover related documents based on content and metadata.

How to install

Prerequisites: you need a working Node.js runtime and npm installed on your system.

Install dependencies for the MCP server and build the project.

Build the server to prepare the runtime artifacts.

Configure your MCP client to connect to the server instance and start using it.

Additional notes

The server provides a set of documentation management tools that you can invoke from your MCP client, including analyzing existing docs, initializing documentation with metadata, updating content and metadata, and performing intelligent searches across your docs.

Available tools

analyze_existing_docs

Analyze and enhance existing documentation with content analysis and metadata generation to improve structure and searchability.

analyze_project_with_metadata

Initialize documentation structure with enhanced content analysis and metadata generation, including front matter and relationships.

analyze_project

Basic initialization of documentation structure from a project source.

read_doc

Read a documentation file to prepare for updates or review.

update_doc

Update documentation using diff-based changes and link-related content.

get_doc_content

Retrieve current content of a documentation file.

get_project_info

Get project structure and documentation status.

search_docs

Search across documentation files with highlighted results and context.

update_metadata

Update documentation metadata for better organization and discovery.

get_related_docs

Find related documentation based on metadata and content links.

customize_template

Create or update documentation templates for consistent formatting.

Built by

VeilStrat

AI signals for GTM teams