RTFM

🚀 MCP-RTFM Server

MCP-RTFM is a powerful document management and analysis server. It addresses the challenges of document organization, search, and analysis, offering a comprehensive solution for efficient document handling.

✨ Features

MCP-RTFM is a powerful document management and analysis server that supports the following core functions:

1. Document Content Linking: Use the [[document-name]] format to create links between documents. The server will automatically track these relationships and return relevant documents during searches.
2. Metadata-based Organization and Management:
   • Classify documents using categories (e.g., "Architecture", "API", "Workflow").
   • Implement grouping through flexible tags.
   • Automatically discover relationships between documents based on shared metadata.
   • Establish associations through content link analysis.
3. Enhanced Content Analysis:
   • Use the unified/remark library for Markdown processing:
     • AST-based content analysis.
     • Accurate detection of title structures.
     • Extraction of code blocks and links.
     • Efficient Markdown parsing and manipulation.
4. Powerful Search Capabilities:
   • Use the minisearch library for fast fuzzy searches.
   • Search based on field weights (title priority).
   • Search full-text content and metadata.
   • Support efficient caching and TTL management.
   • Implement real-time search index updates.
5. Intelligent Metadata Generation:
   • Automatically classify based on content.
   • Intelligently generate tags based on content patterns.
   • Use structured Front-matter in documents.
   • Detect titles and sections based on AST.
   • Identify and mark code snippets.
   • Present results based on context.
6. Template System:
   • Built-in templates for common document types.
   • Support for custom templates with default metadata values.
   • Template inheritance and override functionality.
   • Placeholder system to ensure consistent formatting.

📦 Installation

Installation in VSCode (Roo Cline)

Add the following content to the global settings file:

• 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

The configuration content to be added is as follows:

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

Installation in Claude Desktop

Add the following content to the configuration file:

• Windows: %APPDATA%\Claude\claude_desktop_config.json
• MacOS: ~/Library/Application Support/Claude/claude_desktop_config.json
• Linux: ~/.config/Claude/claude_desktop_config.json

The configuration content to be added is as follows:

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

🚀 Quick Start

Install Dependencies

Run the following command in the project root directory to install all dependencies:

npm install

Start the Server

Use the following command to start the MCP-RTFM server:

node index.js

Debugging Tools

For convenient debugging, you can use the following command to start the server with debugging options:

node --inspect index.js

📚 Documentation Management

Create a New Document

Create a new Markdown file in the project directory and write the content in the following format:

# New Document Title

## Overview

Briefly describe the content or purpose of the document.

### Usage

1. Open the MCP-RTFM server.
2. Navigate to the document management interface.
3. Upload your new document.

### Example Code

```javascript
// This is an example code snippet
function greeting(name) {
    return `Hello, ${name}!`;
}

Related Links

[[Related Document]] [[Another Related Document]]

## 💻 Usage Examples

### Search Function

MCP-RTFM provides a powerful search function that supports the following operations:

1. **Full-text Search**: Enter keywords directly for fuzzy search.
2. **Category-based Search**: Filter documents by category.
3. **Tag-based Search**: Use specific tags to find relevant content.

#### Usage Examples

```bash
// Search for all documents containing the keyword "Architecture"
search --query "Architecture"

// Search by category
search --category "API"

Template System

MCP-RTFM provides a flexible template system that supports the following operations:

1. Create a New Template: Create a new file in the templates directory.
2. Apply an Existing Template: Reference the template in the document using the [[template-name]] format.

Template Example

# Example Document Using a Template

## Document Overview

{{ documentOverview }}

### Specific Content

{{ documentContent }}

🔧 Technical Details

Advanced Features

Automated Workflow

MCP-RTFM supports automated workflows and can be integrated into CI/CD pipelines.

Logging and Monitoring

The server provides detailed logging and monitoring functions to help you track the system's running status.

Security

Authentication and authorization mechanisms are enabled by default to ensure secure access to documents.

Troubleshooting

Common Issues

1. Unable to Start the Server

   Check if the installation is correct, confirm that all dependencies are installed, and view the error information output in the console.

2. Inaccurate Search Results

   Ensure that the index is correctly generated and check if the query syntax is correct.

Contribution

The community is welcome to contribute to the project! Please visit the GitHub repository to submit issues and pull requests.

📄 License

MCP-RTFM is licensed under the Apache 2.0 license. For details, please refer to the LICENSE file.

Thank you for using MCP-RTFM! For more help, please refer to the documentation or contact the support team.